Package com.sas.metadata.remote

Interface PromptGroup

All Superinterfaces:
AbstractPrompt, CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface PromptGroup extends AbstractPrompt
For use by the SAS Prompt Interface. A prompt group will be either associated to a single metadata object or, if acting as a shared prompt group, a member of the SAS tree.

Attributes of PromptGroup are:

Associations of PromptGroup are:

Usage

To create an instance of this PromptGroup, use the factory create methods.
Example: create a PromptGroup with name "PromptGroup_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();
 PromptGroup myObject = (PromptGroup) factory.createComplexMetadataObject(objectStore, "PromptGroup_Object", MetadataObjects.PROMPTGROUP, "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_GROUPTYPE_NAME

      static final String ATTRIBUTE_GROUPTYPE_NAME
      Constant used for the name of the GroupType attribute.

      GroupType: Provides the group type to be used by the UI.

      See Also:

    • ATTRIBUTE_GROUPINFO_NAME

      static final String ATTRIBUTE_GROUPINFO_NAME
      Constant used for the name of the GroupInfo attribute.

      GroupInfo: Private information about the prompt group, to be used only by the prompt interface.

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface AbstractPrompt
      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:
      Specified by:
      initializePredObjects in interface AbstractPrompt
      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.

    • getGroupType

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

    • getGroupTypeState

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

    • getGroupInfo

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

    • getGroupInfoState

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

    • getGroupInfoMaxLength

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

    • setGroupType

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

    • setGroupType

      void setGroupType(int inGroupType, int state) throws RemoteException
      Sets the GroupType Metadata State.
      Parameters:
      inGroupType - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setGroupType

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

    • setGroupType

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

    • setGroupTypeState

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

    • setGroupInfo

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

    • setGroupInfo

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

    • setGroupInfoState

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