*** This interface provides Binary Compatibility only, not Source Compatibility ***

Interface LibraryMemberEntryInterface

All Superinterfaces:
com.sas.entities.EntityKeyInterface, EntryInterface, Remote
All Known Subinterfaces:
DatasetEntryInterface

@SASScope("ALL") @BinaryCompatibilityOnly public interface LibraryMemberEntryInterface extends EntryInterface, Remote
The LibraryMemberEntryInterface provides a mechanism for setting and getting the attributes of a library member entry. A library member entry is an entry that represents one of the following SAS member types: data set, catalog, MDDB, FDB, or SQL view.

Library member entries can only be published using the MVA Publish Framework. The Java API does not support publishing of these SAS members. The Java API can be used to retrieve the metadata that describes these library member entries. Additionally, the DatasetEntryInterface can be used to obtain the actual observations of the SAS data set.

Since:
1.0
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    The entry represents a SAS catalog.
    static final int
    The entry represents a SAS data set.
    static final int
    The entry represents a SAS FDB.
    static final int
    The entry represents a SAS MDDB.
    static final int
    The entry represents a SAS SQL view.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Returns the type of library member.
    String
    Returns the library name.
    String
    Returns the member name.

    Methods inherited from interface com.sas.entities.EntityKeyInterface

    getEntityKey, sameEntity, setEntityKey

    Methods inherited from interface com.sas.services.publish.EntryInterface

    getDescription, getNameValuePairs, getURL, isReadOnly, setDescription, setNameValuePairs
  • Field Details

  • Method Details

    • getMemberName

      String getMemberName() throws RemoteException, TransportException, IllegalStateException
      Returns the member name.
      Returns:
      String The member name.
      Throws:
      TransportException - If the transport encounters an error getting the member name.
      RemoteException - If a network anomaly is encountered.
      IllegalStateException - If the package containing this entry is already closed.
    • getLibraryName

      String getLibraryName() throws TransportException, RemoteException, IllegalStateException
      Returns the library name. Some transports, such as the webdav and archive transports, do not support the library name and will return null. Transports that communicate with a SAS server, such as the requester transport, will return a non-null library name.
      Returns:
      String The library name; can be null.
      Throws:
      TransportException - If the transport encounters an error getting the library name.
      RemoteException - If a network anomaly is encountered.
      IllegalStateException - If the package containing this entry is already closed.
    • getLibraryMemberType

      int getLibraryMemberType() throws RemoteException, IllegalStateException
      Returns the type of library member.
      Returns:
      int The type of library member. Supported types include: DATASET, CATALOG, MDDB, FDB and SQLVIEW.
      Throws:
      RemoteException - If a network anomaly is encountered.
      IllegalStateException - If the package containing this entry is already closed.