Package com.sas.metadata.remote

Interface SASCatalog

All Superinterfaces:
CMetadata, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface SASCatalog extends DeployedDataPackage
Represents a SAS file that stores many different kinds of information in smaller units called catalog entries. A single SAS catalog can contain several different types of catalog entries.

Attributes of SASCatalog are:

Associations of SASCatalog are:

Usage

To create an instance of this SASCatalog, use the factory create methods.
Example: create a SASCatalog with name "SASCatalog_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();
 SASCatalog myObject = (SASCatalog) factory.createComplexMetadataObject(objectStore, "SASCatalog_Object", MetadataObjects.SASCATALOG, "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_SASCATALOGNAME_NAME

      static final String ATTRIBUTE_SASCATALOGNAME_NAME
      Constant used for the name of the SASCatalogName attribute.

      SASCatalogName: The name of the catalog.

      See Also:

    • ASSOCIATION_LIBRARIES_NAME

      static final String ASSOCIATION_LIBRARIES_NAME
      Constant used for the name of the Libraries association.

      Libraries: The libraries that can reference this catalog. 

      See Also:

    • ASSOCIATION_SASCATALOGENTRIES_NAME

      static final String ASSOCIATION_SASCATALOGENTRIES_NAME
      Constant used for the name of the SASCatalogEntries association.

      SASCatalogEntries: *Unknown* 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getSASCatalogName

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

    • getSASCatalogNameState

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

    • getSASCatalogNameMaxLength

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

    • getLibraries

      AssociationList getLibraries() throws RemoteException, MdException
      Gets the Association list of Libraries
      Returns:
      The AssociationList of Libraries which can be of type:
      SASLibrary
      SecuredLibrary
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getSASCatalogEntries

      AssociationList getSASCatalogEntries() throws RemoteException, MdException
      Gets the Association list of SASCatalogEntries
      Returns:
      The AssociationList of SASCatalogEntries which can be of type:
      SASCatalogEntry
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getLibraries

      AssociationList getLibraries(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of Libraries
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the Libraries which can be of type:
      SASLibrary
      SecuredLibrary
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getSASCatalogEntries

      AssociationList getSASCatalogEntries(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of SASCatalogEntries
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the SASCatalogEntries which can be of type:
      SASCatalogEntry
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setSASCatalogName

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

    • setSASCatalogName

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

    • setSASCatalogNameState

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

    • setLibraries

      void setLibraries(AssociationList list) throws RemoteException
      Sets the Libraries list to be list. Objects of which can be of type:
      SASLibrary
      SecuredLibrary
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setLibraries

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

    • setSASCatalogEntries

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

    • setSASCatalogEntries

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