com.sas.metadata.remote
Interface PSLayoutComponent

All Superinterfaces:

CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, java.rmi.Remote, Root

All Known Subinterfaces:

PSColumnLayoutComponent

public interface PSLayoutComponent
extends PrimaryType

A UI element that designates how Portlets should be laid out on a PortalPage.

Attributes of PSLayoutComponent are:

Associations of PSLayoutComponent are:

• OwningPage
• Portlets

Usage

To create an instance of this PSLayoutComponent, use the factory create methods.
Example: create a PSLayoutComponent with name "PSLayoutComponent_Object", in repository "AAAAAAAA".

 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 PSLayoutComponent myObject = (PSLayoutComponent) factory.createComplexMetadataObject(objectStore, "PSLayoutComponent_Object", MetadataObjects.PSLAYOUTCOMPONENT, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed
 

Behavior

• Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
• When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
• If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:

9.0

Field Summary

static java.lang.String	ASSOCIATION_OWNINGPAGE_NAME Constant used for the name of the OwningPage association.
static java.lang.String	ASSOCIATION_PORTLETS_NAME Constant used for the name of the Portlets association.

Fields inherited from interface com.sas.metadata.remote.PrimaryType

ASSOCIATION_FAVORITESCONTAINERS_NAME, ATTRIBUTE_ISHIDDEN_NAME, ATTRIBUTE_PUBLICTYPE_NAME

Fields inherited from interface com.sas.metadata.remote.Root

ASSOCIATION_ACCESSCONTROLS_NAME, ASSOCIATION_CHANGES_NAME, ASSOCIATION_CUSTOMASSOCIATIONS_NAME, ASSOCIATION_DOCUMENTS_NAME, ASSOCIATION_EXTENSIONS_NAME, ASSOCIATION_EXTERNALIDENTITIES_NAME, ASSOCIATION_GROUPS_NAME, ASSOCIATION_IMPLEMENTORS_NAME, ASSOCIATION_KEYWORDS_NAME, ASSOCIATION_LOCALIZEDATTRIBUTES_NAME, ASSOCIATION_NOTES_NAME, ASSOCIATION_PRIMARYPROPERTYGROUP_NAME, ASSOCIATION_PROMPTS_NAME, ASSOCIATION_PROPERTIES_NAME, ASSOCIATION_PROPERTYSETS_NAME, ASSOCIATION_REFERENCEDOBJECTS_NAME, ASSOCIATION_RESPONSIBLEPARTIES_NAME, ASSOCIATION_SOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECSOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECTARGETTRANSFORMATIONS_NAME, ASSOCIATION_TARGETTRANSFORMATIONS_NAME, ASSOCIATION_TIMESTAMPS_NAME, ASSOCIATION_TREES_NAME, ASSOCIATION_TSOBJECTNAMESPACE_NAME, ASSOCIATION_USEDBYPROTOTYPES_NAME, ASSOCIATION_USINGPROTOTYPE_NAME, ASSOCIATION_VARIABLES_NAME, ATTRIBUTE_CHANGESTATE_NAME, ATTRIBUTE_LOCKEDBY_NAME, ATTRIBUTE_USAGEVERSION_NAME

Fields inherited from interface com.sas.metadata.remote.MdObjectBase

ATTRIBUTE_DESC_NAME, ATTRIBUTE_ID_NAME, ATTRIBUTE_METADATACREATED_NAME, ATTRIBUTE_METADATAUPDATED_NAME, ATTRIBUTE_NAME_NAME

Method Summary

PSPortalPage	getOwningPage() Gets the PSPortalPage for OwningPage
AssociationList	getOwningPages() Gets the AssociationList of OwningPages
AssociationList	getOwningPages(boolean fGoToServer) Gets the Associationlist of OwningPages
AssociationList	getPortlets() Gets the Association list of Portlets
AssociationList	getPortlets(boolean fGoToServer) Gets the Associationlist of Portlets
void	initializePredObjects() (S) Adds the Associated objects to the predObjects which are: OwningPage
void	initializeRequiredObjects() (S) This initializes the Required Objects(Roles) which are: OwningPage
void	setOwningPage(PSPortalPage inObject) Sets the OwningPages list 0th element to be inObject.
void	setOwningPages(AssociationList list) Sets the OwningPages list to be list.
void	setOwningPages(AssociationList list, int state) Sets the OwningPages list to be list.
void	setPortlets(AssociationList list) Sets the Portlets list to be list.
void	setPortlets(AssociationList inObjects, int state) Sets the entire Portlets list to match the passed in AssociationList, sets the state of the Portlets

Methods inherited from interface com.sas.metadata.remote.PrimaryType

getFavoritesContainers, getFavoritesContainers, getIsHidden, getIsHiddenState, getPublicType, getPublicTypeMaxLength, getPublicTypeState, setFavoritesContainers, setFavoritesContainers, setIsHidden, setIsHidden, setIsHidden, setIsHidden, setIsHiddenState, setPublicType, setPublicType, setPublicTypeState

Methods inherited from interface com.sas.metadata.remote.Root

getAccessControls, getAccessControls, getChanges, getChanges, getChangeState, getChangeStateMaxLength, getChangeStateState, getCustomAssociations, getCustomAssociations, getDocuments, getDocuments, getExtensions, getExtensions, getExternalIdentities, getExternalIdentities, getGroups, getGroups, getImplementors, getImplementors, getKeywords, getKeywords, getLocalizedAttributes, getLocalizedAttributes, getLockedBy, getLockedByMaxLength, getLockedByState, getNotes, getNotes, getPrimaryPropertyGroup, getPrimaryPropertyGroups, getPrimaryPropertyGroups, getPrompts, getPrompts, getProperties, getProperties, getPropertySets, getPropertySets, getReferencedObjects, getReferencedObjects, getResponsibleParties, getResponsibleParties, getSourceTransformations, getSourceTransformations, getSpecSourceTransformations, getSpecSourceTransformations, getSpecTargetTransformations, getSpecTargetTransformations, getTargetTransformations, getTargetTransformations, getTimestamps, getTimestamps, getTrees, getTrees, getTSObjectNamespace, getTSObjectNamespaces, getTSObjectNamespaces, getUsageVersion, getUsageVersionState, getUsedByPrototypes, getUsedByPrototypes, getUsingPrototype, getUsingPrototypes, getUsingPrototypes, getVariables, getVariables, setAccessControls, setAccessControls, setChanges, setChanges, setChangeState, setChangeState, setChangeStateState, setCustomAssociations, setCustomAssociations, setDocuments, setDocuments, setExtensions, setExtensions, setExternalIdentities, setExternalIdentities, setGroups, setGroups, setImplementors, setImplementors, setKeywords, setKeywords, setLocalizedAttributes, setLocalizedAttributes, setLockedBy, setLockedBy, setLockedByState, setNotes, setNotes, setPrimaryPropertyGroup, setPrimaryPropertyGroups, setPrimaryPropertyGroups, setPrompts, setPrompts, setProperties, setProperties, setPropertySets, setPropertySets, setReferencedObjects, setReferencedObjects, setResponsibleParties, setResponsibleParties, setSourceTransformations, setSourceTransformations, setSpecSourceTransformations, setSpecSourceTransformations, setSpecTargetTransformations, setSpecTargetTransformations, setTargetTransformations, setTargetTransformations, setTimestamps, setTimestamps, setTrees, setTrees, setTSObjectNamespace, setTSObjectNamespaces, setTSObjectNamespaces, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersionState, setUsedByPrototypes, setUsedByPrototypes, setUsingPrototype, setUsingPrototypes, setUsingPrototypes, setVariables, setVariables

Methods inherited from interface com.sas.metadata.remote.MdObjectBaseXML

closeUpdateMetadataXML, createEmptyXML, createObjectRefreshXML, createObjectXML, createObjectXML, createUpdateAssociationXML, createUpdateAssociationXML, createUpdateSimpleXML, doCreateUpdateXML, getUpdateSimpleSubstring, updateMetadataAll

Methods inherited from interface com.sas.metadata.remote.MdObjectBaseUtil

addMdObjectListener, delete, dispose, fireMdObjectModified, getAssociatedObjects, getAssociatedObjects, getAssociatedObjects, getAssociationNames, getAssocs, getAssocsWA, getAttributeNames, getAttrs, getAttrsStates, getChangeManagementState, getChgMgtExternalIdentityImportType, getClientSideOnlyObject, getMdObjectAssociation, getPopulatedAssocs, getUpdatedAttrs, getViewList, isCheckedOut, isLocked, objectModified, removeMdObjectListener, setAttrs, setChangeManagementTargetRepository, setChgMgtExternalIdentityImportType, setClientSideOnlyObject, setMdObjectAssociation, touch, updateAssnsIds

Methods inherited from interface com.sas.metadata.remote.MdObjectBase

addElementToChangeList, clearChangeList, getChangeList, getCMetadataType, getDesc, getDescMaxLength, getDescState, getFQID, getId, getIdState, getMetadataCreated, getMetadataCreatedState, getMetadataUpdated, getMetadataUpdatedState, getName, getNameMaxLength, getNameState, getObjectStore, getPredAssociations, getRepositoryID, getRequiredAssociations, getState, isAssociationRequired, isNewObject, isPredAssociation, removeElementFromChangeList, resetObject, resetState, resetStates, setCMetadataType, setDesc, setDesc, setDescState, setFQID, setFQID, setId, setId, setIdState, setMetadataCreated, setMetadataCreated, setMetadataCreatedState, setMetadataUpdated, setMetadataUpdated, setMetadataUpdatedState, setName, setName, setNameState, setObjectStore, setState

Field Detail

ASSOCIATION_OWNINGPAGE_NAME

static final java.lang.String ASSOCIATION_OWNINGPAGE_NAME

Constant used for the name of the OwningPage association.

OwningPage: The PortalPage that this Layout applies to

See Also:

Constant Field Values

ASSOCIATION_PORTLETS_NAME

static final java.lang.String ASSOCIATION_PORTLETS_NAME

Constant used for the name of the Portlets association.

Portlets: The Portlets to be displayed on the PortalPage

See Also:

Constant Field Values

Method Detail

initializeRequiredObjects

void initializeRequiredObjects()
                               throws java.rmi.RemoteException

(S) This initializes the Required Objects(Roles) which are:
OwningPage

Specified by:

initializeRequiredObjects in interface MdObjectBaseUtil

Specified by:

initializeRequiredObjects in interface PrimaryType

Specified by:

initializeRequiredObjects in interface Root

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

initializePredObjects

void initializePredObjects()
                           throws java.rmi.RemoteException

(S) Adds the Associated objects to the predObjects which are:
OwningPage

Specified by:

initializePredObjects in interface MdObjectBase

Specified by:

initializePredObjects in interface PrimaryType

Specified by:

initializePredObjects in interface Root

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getOwningPages

AssociationList getOwningPages()
                               throws java.rmi.RemoteException,
                                      MdException

Gets the AssociationList of OwningPages

Returns:

Returns the AssociationList of OwningPages which can be of type:
PSPortalPage

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException

getOwningPage

PSPortalPage getOwningPage()
                           throws java.rmi.RemoteException,
                                  MdException

Gets the PSPortalPage for OwningPage

Returns:

The PSPortalPage ( null if not set) of OwningPagewhich can be of type:
PSPortalPage

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getPortlets

AssociationList getPortlets()
                            throws java.rmi.RemoteException,
                                   MdException

Gets the Association list of Portlets

Returns:

The AssociationList of Portlets which can be of type:
PSPortlet

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getOwningPages

AssociationList getOwningPages(boolean fGoToServer)
                               throws java.rmi.RemoteException,
                                      MdException

Gets the Associationlist of OwningPages

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the AssociationList of OwningPages which can be of type:
PSPortalPage

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getPortlets

AssociationList getPortlets(boolean fGoToServer)
                            throws java.rmi.RemoteException,
                                   MdException

Gets the Associationlist of Portlets

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the Portlets which can be of type:
PSPortlet

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

setOwningPages

void setOwningPages(AssociationList list)
                    throws java.rmi.RemoteException

Sets the OwningPages list to be list. Object of which can be of type:
PSPortalPage

Parameters:

list - AssociationList

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setOwningPages

void setOwningPages(AssociationList list,
                    int state)
                    throws java.rmi.RemoteException

Sets the OwningPages list to be list. Object of which can be of type:
PSPortalPage

Parameters:

list - AssociationList

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setOwningPage

void setOwningPage(PSPortalPage inObject)
                   throws java.rmi.RemoteException

Sets the OwningPages list 0th element to be inObject.

Parameters:

inObject - PSPortalPage

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setPortlets

void setPortlets(AssociationList list)
                 throws java.rmi.RemoteException

Sets the Portlets list to be list. Objects of which can be of type:
PSPortlet

Parameters:

list - AssociationList

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setPortlets

void setPortlets(AssociationList inObjects,
                 int state)
                 throws java.rmi.RemoteException

Sets the entire Portlets list to match the passed in AssociationList, sets the state of the Portlets

Parameters:

inObjects - AssociationList

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.