Package com.sas.metadata.remote

Interface PSLayoutComponent

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, 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:

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 Details

    • ASSOCIATION_OWNINGPAGE_NAME

      static final String ASSOCIATION_OWNINGPAGE_NAME
      Constant used for the name of the OwningPage association.

      OwningPage: The PortalPage that this Layout applies to  

      See Also:

    • ASSOCIATION_PORTLETS_NAME

      static final String ASSOCIATION_PORTLETS_NAME
      Constant used for the name of the Portlets association.

      Portlets: The Portlets to be displayed on the PortalPage 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws 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:
      RemoteException - If error connecting/communicating to/with remote object.

    • initializePredObjects

      void initializePredObjects() throws 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:
      RemoteException - If error connecting/communicating to/with remote object.

    • getOwningPages

      AssociationList getOwningPages() throws RemoteException, MdException
      Gets the AssociationList of OwningPages
      Returns:
      Returns the AssociationList of OwningPages which can be of type:
      PSPortalPage
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getOwningPage

      PSPortalPage getOwningPage() throws RemoteException, MdException
      Gets the PSPortalPage for OwningPage
      Returns:
      The PSPortalPage ( null if not set) of OwningPagewhich can be of type:
      PSPortalPage
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getPortlets

      AssociationList getPortlets() throws RemoteException, MdException
      Gets the Association list of Portlets
      Returns:
      The AssociationList of Portlets which can be of type:
      PSPortlet
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getOwningPages

      AssociationList getOwningPages(boolean fGoToServer) throws 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:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getPortlets

      AssociationList getPortlets(boolean fGoToServer) throws 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:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setOwningPages

      void setOwningPages(AssociationList list) throws RemoteException
      Sets the OwningPages list to be list. Object of which can be of type:
      PSPortalPage
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningPages

      void setOwningPages(AssociationList list, int state) throws RemoteException
      Sets the OwningPages list to be list. Object of which can be of type:
      PSPortalPage
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningPage

      void setOwningPage(PSPortalPage inObject) throws RemoteException
      Sets the OwningPages list 0th element to be inObject.
      Parameters:
      inObject - PSPortalPage
      Throws:
      RemoteException - If error communicating with remote object.

    • setPortlets

      void setPortlets(AssociationList list) throws RemoteException
      Sets the Portlets list to be list. Objects of which can be of type:
      PSPortlet
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setPortlets

      void setPortlets(AssociationList inObjects, int state) throws RemoteException
      Sets the entire Portlets list to match the passed in AssociationList, sets the state of the Portlets
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.