Package com.sas.metadata.remote

Interface SASCatalogEntry

All Superinterfaces:
CMetadata, ContentLocation, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root, Text
public interface SASCatalogEntry extends Text
Represents a separate storage unit within a SAS catalog. Each entry has an entry type that identifies its purpose to SAS. Some catalog entries contain system information such as key definitions. Other catalog entries contain application information such as window definitions, help windows, formats, informats, macros, or graphics output.

Attributes of SASCatalogEntry are:

Associations of SASCatalogEntry are:

Usage

To create an instance of this SASCatalogEntry, use the factory create methods.
Example: create a SASCatalogEntry with name "SASCatalogEntry_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();
 SASCatalogEntry myObject = (SASCatalogEntry) factory.createComplexMetadataObject(objectStore, "SASCatalogEntry_Object", MetadataObjects.SASCATALOGENTRY, "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_CATALOGENTRYTYPE_NAME

      static final String ATTRIBUTE_CATALOGENTRYTYPE_NAME
      Constant used for the name of the CatalogEntryType attribute.

      CatalogEntryType: The catalog entry type.

      See Also:

    • ATTRIBUTE_CATALOGENTRYNAME_NAME

      static final String ATTRIBUTE_CATALOGENTRYNAME_NAME
      Constant used for the name of the CatalogEntryName attribute.

      CatalogEntryName: The name of the catalog entry.

      See Also:

    • ATTRIBUTE_ISNAMEFULLYQUALIFIED_NAME

      static final String ATTRIBUTE_ISNAMEFULLYQUALIFIED_NAME
      Constant used for the name of the IsNameFullyQualified attribute.

      IsNameFullyQualified: If the name represents the four-level entry name (library, catalog, entry, type) then this value should be true; otherwise, it should be false.

      See Also:

    • ASSOCIATION_ASSOCIATEDSASCATALOG_NAME

      static final String ASSOCIATION_ASSOCIATEDSASCATALOG_NAME
      Constant used for the name of the AssociatedSASCatalog association.

      AssociatedSASCatalog: The SAS catalog that contains this entry.  

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface ContentLocation
      Specified by:
      initializeRequiredObjects in interface DeployedDataPackage
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface PrimaryType
      Specified by:
      initializeRequiredObjects in interface Root
      Specified by:
      initializeRequiredObjects in interface Text
      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:
      AssociatedSASCatalog
      Specified by:
      initializePredObjects in interface ContentLocation
      Specified by:
      initializePredObjects in interface DeployedDataPackage
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface PrimaryType
      Specified by:
      initializePredObjects in interface Root
      Specified by:
      initializePredObjects in interface Text
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getCatalogEntryType

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

    • getCatalogEntryTypeState

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

    • getCatalogEntryTypeMaxLength

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

    • getCatalogEntryName

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

    • getCatalogEntryNameState

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

    • getCatalogEntryNameMaxLength

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

    • getIsNameFullyQualified

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

    • getIsNameFullyQualifiedState

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

    • getAssociatedSASCatalogs

      AssociationList getAssociatedSASCatalogs() throws RemoteException, MdException
      Gets the AssociationList of AssociatedSASCatalogs
      Returns:
      Returns the AssociationList of AssociatedSASCatalogs which can be of type:
      SASCatalog
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getAssociatedSASCatalog

      SASCatalog getAssociatedSASCatalog() throws RemoteException, MdException
      Gets the SASCatalog for AssociatedSASCatalog
      Returns:
      The SASCatalog ( null if not set) of AssociatedSASCatalogwhich can be of type:
      SASCatalog
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getAssociatedSASCatalogs

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

    • setCatalogEntryType

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

    • setCatalogEntryType

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

    • setCatalogEntryTypeState

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

    • setCatalogEntryName

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

    • setCatalogEntryName

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

    • setCatalogEntryNameState

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

    • setIsNameFullyQualified

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

    • setIsNameFullyQualified

      void setIsNameFullyQualified(int inIsNameFullyQualified, int state) throws RemoteException
      Sets the IsNameFullyQualified Metadata State.
      Parameters:
      inIsNameFullyQualified - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsNameFullyQualified

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

    • setIsNameFullyQualified

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

    • setIsNameFullyQualifiedState

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

    • setAssociatedSASCatalogs

      void setAssociatedSASCatalogs(AssociationList list) throws RemoteException
      Sets the AssociatedSASCatalogs list to be list. Object of which can be of type:
      SASCatalog
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedSASCatalogs

      void setAssociatedSASCatalogs(AssociationList list, int state) throws RemoteException
      Sets the AssociatedSASCatalogs list to be list. Object of which can be of type:
      SASCatalog
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedSASCatalog

      void setAssociatedSASCatalog(SASCatalog inObject) throws RemoteException
      Sets the AssociatedSASCatalogs list 0th element to be inObject.
      Parameters:
      inObject - SASCatalog
      Throws:
      RemoteException - If error communicating with remote object.