Package com.sas.metadata.remote

Interface PSPortalProfile

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface PSPortalProfile extends PrimaryType
A SAS Information Delivery Portal user's portal information, which defines the basic functionality of the portal.

Attributes of PSPortalProfile are:

Associations of PSPortalProfile are:

Usage

To create an instance of this PSPortalProfile, use the factory create methods.
Example: create a PSPortalProfile with name "PSPortalProfile_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();
 PSPortalProfile myObject = (PSPortalProfile) factory.createComplexMetadataObject(objectStore, "PSPortalProfile_Object", MetadataObjects.PSPORTALPROFILE, "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_PREFERREDLOCALE_NAME

      static final String ATTRIBUTE_PREFERREDLOCALE_NAME
      Constant used for the name of the PreferredLocale attribute.

      PreferredLocale: A locale that can be used if the client's browser locale is not supported by the application.

      See Also:

    • ASSOCIATION_PORTALPAGES_NAME

      static final String ASSOCIATION_PORTALPAGES_NAME
      Constant used for the name of the PortalPages association.

      PortalPages: The portal pages associated with this profile.  

      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 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:
      PortalPages
      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.

    • getPreferredLocale

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

    • getPreferredLocaleState

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

    • getPreferredLocaleMaxLength

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

    • getPortalPages

      AssociationList getPortalPages() throws RemoteException, MdException
      Gets the AssociationList of PortalPages
      Returns:
      Returns the AssociationList of PortalPages 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.

    • getPortalPages

      AssociationList getPortalPages(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of PortalPages
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of PortalPages 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.

    • setPreferredLocale

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

    • setPreferredLocale

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

    • setPreferredLocaleState

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

    • setPortalPages

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

    • setPortalPages

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