Package com.sas.metadata.remote

Interface PSColumnLayoutComponent

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, PSLayoutComponent, Remote, Root
public interface PSColumnLayoutComponent extends PSLayoutComponent
Provides the information needed to lay a PortalPage out in columns.

Attributes of PSColumnLayoutComponent are:

Associations of PSColumnLayoutComponent are:

Usage

To create an instance of this PSColumnLayoutComponent, use the factory create methods.
Example: create a PSColumnLayoutComponent with name "PSColumnLayoutComponent_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();
 PSColumnLayoutComponent myObject = (PSColumnLayoutComponent) factory.createComplexMetadataObject(objectStore, "PSColumnLayoutComponent_Object", MetadataObjects.PSCOLUMNLAYOUTCOMPONENT, "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

    • ATTRIBUTE_COLUMNWIDTH_NAME

      static final String ATTRIBUTE_COLUMNWIDTH_NAME
      Constant used for the name of the ColumnWidth attribute.

      ColumnWidth: Designates the width of the screen area that the component should be rendered in.

      See Also:

    • ATTRIBUTE_NUMBEROFPORTLETS_NAME

      static final String ATTRIBUTE_NUMBEROFPORTLETS_NAME
      Constant used for the name of the NumberOfPortlets attribute.

      NumberOfPortlets: Provides the number of Portlets associated to be displayed in the column. Should be the same as the number of Portlets associated with the ColumnLayoutComponent.

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface PrimaryType
      Specified by:
      initializeRequiredObjects in interface PSLayoutComponent
      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:
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface PrimaryType
      Specified by:
      initializePredObjects in interface PSLayoutComponent
      Specified by:
      initializePredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getColumnWidth

      String getColumnWidth() throws RemoteException
      Gets the String value of ColumnWidth
      Returns:
      The ColumnWidth
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getColumnWidthState

      int getColumnWidthState() throws RemoteException
      Gets the Metadata State of ColumnWidth
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getColumnWidthMaxLength

      int getColumnWidthMaxLength() throws RemoteException
      Gets the maximum length of ColumnWidth
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getNumberOfPortlets

      int getNumberOfPortlets() throws RemoteException
      Gets the int value of NumberOfPortlets
      Returns:
      The NumberOfPortlets
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getNumberOfPortletsState

      int getNumberOfPortletsState() throws RemoteException
      Gets the Metadata State of NumberOfPortlets
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • setColumnWidth

      void setColumnWidth(String inColumnWidth) throws RemoteException
      Sets the ColumnWidth value and sets the state to MetadataState.LOCAL.
      Parameters:
      inColumnWidth - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setColumnWidth

      void setColumnWidth(String inColumnWidth, int state) throws RemoteException
      Sets the ColumnWidth Metadata State.
      Parameters:
      inColumnWidth - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setColumnWidthState

      void setColumnWidthState(int state) throws RemoteException
      Sets the Metadata State of ColumnWidth.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setNumberOfPortlets

      void setNumberOfPortlets(int inNumberOfPortlets) throws RemoteException
      Sets the NumberOfPortlets value and sets the state to MetadataState.LOCAL.
      Parameters:
      inNumberOfPortlets - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setNumberOfPortlets

      void setNumberOfPortlets(int inNumberOfPortlets, int state) throws RemoteException
      Sets the NumberOfPortlets Metadata State.
      Parameters:
      inNumberOfPortlets - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setNumberOfPortlets

      void setNumberOfPortlets(String inNumberOfPortlets) throws RemoteException
      Sets the NumberOfPortlets value and sets the state to MetadataState.LOCAL.
      Parameters:
      inNumberOfPortlets - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setNumberOfPortlets

      void setNumberOfPortlets(String inNumberOfPortlets, int state) throws RemoteException
      Sets the NumberOfPortlets value and Metadata State.
      Parameters:
      inNumberOfPortlets - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setNumberOfPortletsState

      void setNumberOfPortletsState(int state) throws RemoteException
      Sets the Metadata State of NumberOfPortlets.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.