Package com.sas.metadata.remote

Interface Search

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface Search extends PrimaryType
This object is used to store information for search definitions.

Attributes of Search are:

Associations of Search are:

Usage

To create an instance of this Search, use the factory create methods.
Example: create a Search with name "Search_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();
 Search myObject = (Search) factory.createComplexMetadataObject(objectStore, "Search_Object", MetadataObjects.SEARCH, "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_DETAILS_NAME

      static final String ATTRIBUTE_DETAILS_NAME
      Constant used for the name of the Details attribute.

      Details: Details

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

    • getDetails

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

    • getDetailsState

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

    • getDetailsMaxLength

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

    • setDetails

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

    • setDetails

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

    • setDetailsState

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