Package com.sas.services.information.metadata

Interface ContentSubscriberInterface

All Superinterfaces:
MetadataInterface, PublicObjectInterface, Remote, SubscriberInterface
public interface ContentSubscriberInterface extends SubscriberInterface
Package subscriber interface.
Since:
1.1

  • Field Details

    • EMAIL_FORMAT_HTML

      static final String EMAIL_FORMAT_HTML
      Email format code: HTML
      See Also:

    • EMAIL_FORMAT_TEXT

      static final String EMAIL_FORMAT_TEXT
      Email format code: text
      See Also:

    • DEFAULT_EMAIL_FORMAT

      static final String DEFAULT_EMAIL_FORMAT
      The default Email format.
      See Also:

    • EMAIL_TYPE

      static final String EMAIL_TYPE
      A value used to indicate that the Email address is being used for a publishing framework subscriber.
      See Also:

    • WEBDAV_URL_TYPE_COLLECTION

      static final String WEBDAV_URL_TYPE_COLLECTION
      WebDAV URL type code: collection
      See Also:

    • WEBDAV_URL_TYPE_PARENT

      static final String WEBDAV_URL_TYPE_PARENT
      WebDAV URL type code: parent
      See Also:

    • DEFAULT_WEBDAV_URL_TYPE

      static final String DEFAULT_WEBDAV_URL_TYPE
      The default WebDAV URL type code.
      See Also:

  • Method Details

    • getMail

      String getMail() throws ServiceException, RemoteException
      Gets the mail address to send to for this subscriber.
      Returns:
      The mail address, or null if there isn't one.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • setMail

      void setMail(String mail) throws ServiceException, RemoteException
      Sets the mail address to send to for this user.
      Parameters:
      mail - The mail address
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • getEmailFormat

      String getEmailFormat() throws ServiceException, RemoteException
      Gets the email format for this subcriber. The format will be one of the following:
      Returns:
      The preferred format for published email for this subscriber. This value will be one of EMAIL_FORMAT_HTML or EMAIL_FORMAT_TEXT
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • setEmailFormat

      void setEmailFormat(String emailFormat) throws ServiceException, RemoteException
      Sets the preferred email format for this subscriber. The format must be one of the following:
      Parameters:
      emailFormat - The preferred email format. This value must be one of EMAIL_FORMAT_HTML or EMAIL_FORMAT_TEXT
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • getArchiveReceiveBy

      String getArchiveReceiveBy() throws ServiceException, RemoteException
      Gets the receive method this subscriber prefers (value or reference).
      Returns:
      The preferred receive mechanism for this subscriber.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • setArchiveReceiveBy

      void setArchiveReceiveBy(String receiveBy) throws ServiceException, RemoteException
      Sets the preferred mechanism for receiving published archives (value or reference).
      Parameters:
      receiveBy - method for receiving archive data.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • nameValueInclusionFilters

      List nameValueInclusionFilters() throws ServiceException, RemoteException
      Gets the name/value inclusion filters defined for filtering data received by this subscriber identity.
      Returns:
      The name/value inclusion filter iterator.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - in the event of remote object failure.

    • addNameValueInclusionFilter

      void addNameValueInclusionFilter(String filter) throws ServiceException, RemoteException
      Adds a name/value inclusion filter to the subscriber.
      Parameters:
      filter - The new package inclusion filter.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • removeNameValueInclusionFilter

      void removeNameValueInclusionFilter(String filter) throws ServiceException, RemoteException
      Remove a name/value inclusion filter from the subscriber.
      Parameters:
      filter - The package inclusion filter to remove.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • nameValueExclusionFilters

      List nameValueExclusionFilters() throws ServiceException, RemoteException
      Gets the name/value exclusion filters defined for filtering data received by this subscriber identity.
      Returns:
      The name/value exclusion filter List.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • addNameValueExclusionFilter

      void addNameValueExclusionFilter(String filter) throws ServiceException, RemoteException
      Adds a name/value exclusion filter to the subscriber.
      Parameters:
      filter - The new package exclusion filter.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • removeNameValueExclusionFilter

      void removeNameValueExclusionFilter(String filter) throws ServiceException, RemoteException
      Remove a name/value exclusion filter from the subscriber.
      Parameters:
      filter - The package exclusion filter to remove.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • entryExclusionFilters

      List entryExclusionFilters() throws ServiceException, RemoteException
      Gets the entry exclusion filters defined for filtering content to this subscriber.
      Returns:
      the entry exclusion filters for this user.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • addEntryExclusionFilter

      void addEntryExclusionFilter(String filter) throws ServiceException, RemoteException
      Add an entry exclusion filter to this subscriber.
      Parameters:
      filter - The new entry exclusion filter.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • removeEntryExclusionFilter

      void removeEntryExclusionFilter(String filter) throws ServiceException, RemoteException
      Remove an entry exclusion filter from this subscriber.
      Parameters:
      filter - The entry exclusion filter to remove.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • entryInclusionFilters

      List entryInclusionFilters() throws ServiceException, RemoteException
      Gets the entry inclusion filters defined for filtering content to this subscriber.
      Returns:
      the entry inclusion filters for this user.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • addEntryInclusionFilter

      void addEntryInclusionFilter(String filter) throws ServiceException, RemoteException
      Add an entry inclusion filter to this subscriber.
      Parameters:
      filter - The entry inclusion filter to add.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • removeEntryInclusionFilter

      void removeEntryInclusionFilter(String filter) throws ServiceException, RemoteException
      Remove an entry inclusion filter from the subscriber.
      Parameters:
      filter - The entry inclusion filter to remove.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • fileMimeTypeExclusionFilters

      List fileMimeTypeExclusionFilters() throws ServiceException, RemoteException
      Gets the file MIME type exclusion filters for this user.
      Returns:
      The file MIME type exclusion filters.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • addFileMimeTypeExclusionFilter

      void addFileMimeTypeExclusionFilter(String filter) throws ServiceException, RemoteException
      Add a file type exclusion filter.
      Parameters:
      filter - The new file type exclusion filter.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • removeFileMimeTypeExclusionFilter

      void removeFileMimeTypeExclusionFilter(String filter) throws ServiceException, RemoteException
      Remove a file type exclusion filter.
      Parameters:
      filter - The file type exclusion filter to remove.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • fileMimeTypeInclusionFilters

      List fileMimeTypeInclusionFilters() throws ServiceException, RemoteException
      Gets the file MIME type inclusion filters for this user.
      Returns:
      The file MIME type inclusion filters.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • addFileMimeTypeInclusionFilter

      void addFileMimeTypeInclusionFilter(String filter) throws ServiceException, RemoteException
      Add a file type inclusion filter.
      Parameters:
      filter - The file type inclusion filter to add.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • removeFileMimeTypeInclusionFilter

      void removeFileMimeTypeInclusionFilter(String filter) throws ServiceException, RemoteException
      Remove a file type inclusion filter.
      Parameters:
      filter - The file type inclusion filter to remove.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • getDavUrlType

      String getDavUrlType() throws ServiceException, RemoteException
      Sets the type of url. For webDAV servers, the url can either be a parent or collection url.
      Returns:
      The type of url, parent or collection.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • setDavUrlType

      void setDavUrlType(String type) throws ServiceException, RemoteException
      Sets the type of url. For webDAV servers, the url can either be a parent or collection url.
      Parameters:
      type - The type of url, parent or collection.
      Throws:
      ServiceException - if a service level error occurs.
      RemoteException - if a network anomaly is encountered.

    • removeFilters

      void removeFilters() throws ServiceException, RemoteException
      Remove all filters for this subscriber. This will remove all inclusion and exclusion filters for name/value pairs, MIME types and entry types.
      Throws:
      ServiceException - if an exception was encountered removing the filters.
      RemoteException - if a networking issue is encountered.