Package com.sas.metadata.remote

Interface Prompt

All Superinterfaces:
AbstractPrompt, CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface Prompt extends AbstractPrompt
For use by the SAS Prompt Interface. The SAS Prompt Interface allows prompts to be defined as either shared or private. A private prompt is visible and used only by the prompt enabled object and may reference a shared prompt. A shared prompt is a prompt that is publicly visible and may be used by multiple objects. A prompt will be either associated to a single metadata object or, if acting as a shared prompt, a member ofa SAS Folder.

Attributes of Prompt are:

Associations of Prompt are:

Usage

To create an instance of this Prompt, use the factory create methods.
Example: create a Prompt with name "Prompt_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();
 Prompt myObject = (Prompt) factory.createComplexMetadataObject(objectStore, "Prompt_Object", MetadataObjects.PROMPT, "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_PROMPTTYPE_NAME

      static final String ATTRIBUTE_PROMPTTYPE_NAME
      Constant used for the name of the PromptType attribute.

      PromptType: Provides the input type to be used by the UI - such as textbox, checkbox

      See Also:

    • ATTRIBUTE_PROMPTINFO_NAME

      static final String ATTRIBUTE_PROMPTINFO_NAME
      Constant used for the name of the PromptInfo attribute.

      PromptInfo: Private information about the prompt, 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.

    • getPromptType

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

    • getPromptTypeState

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

    • getPromptInfo

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

    • getPromptInfoState

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

    • getPromptInfoMaxLength

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

    • setPromptType

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

    • setPromptType

      void setPromptType(int inPromptType, int state) throws RemoteException
      Sets the PromptType Metadata State.
      Parameters:
      inPromptType - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setPromptType

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

    • setPromptType

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

    • setPromptTypeState

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

    • setPromptInfo

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

    • setPromptInfo

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

    • setPromptInfoState

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