com.sas.services.information.metadata
Interface ContentSubscriberInterface

All Superinterfaces:

MetadataInterface, PublicObjectInterface, java.rmi.Remote, SubscriberInterface

public interface ContentSubscriberInterface
extends SubscriberInterface

Package subscriber interface.

Since:

1.1

Field Summary

static java.lang.String	DEFAULT_EMAIL_FORMAT The default Email format.
static java.lang.String	DEFAULT_WEBDAV_URL_TYPE The default WebDAV URL type code.
static java.lang.String	EMAIL_FORMAT_HTML Email format code: HTML
static java.lang.String	EMAIL_FORMAT_TEXT Email format code: text
static java.lang.String	EMAIL_TYPE A value used to indicate that the Email address is being used for a publishing framework subscriber.
static java.lang.String	WEBDAV_URL_TYPE_COLLECTION WebDAV URL type code: collection
static java.lang.String	WEBDAV_URL_TYPE_PARENT WebDAV URL type code: parent

Fields inherited from interface com.sas.services.information.metadata.SubscriberInterface

SUBSCRIBER_CONTENT, SUBSCRIBER_EVENT

Fields inherited from interface com.sas.services.information.metadata.MetadataInterface

METADATA_STATE_DELETED, METADATA_STATE_DESTROYED, METADATA_STATE_NEW, METADATA_STATE_NORMAL, PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

abstract void	addEntryExclusionFilter(java.lang.String filter) Add an entry exclusion filter to this subscriber.
abstract void	addEntryInclusionFilter(java.lang.String filter) Add an entry inclusion filter to this subscriber.
abstract void	addFileMimeTypeExclusionFilter(java.lang.String filter) Add a file type exclusion filter.
abstract void	addFileMimeTypeInclusionFilter(java.lang.String filter) Add a file type inclusion filter.
abstract void	addNameValueExclusionFilter(java.lang.String filter) Adds a name/value exclusion filter to the subscriber.
abstract void	addNameValueInclusionFilter(java.lang.String filter) Adds a name/value inclusion filter to the subscriber.
abstract java.util.List	entryExclusionFilters() Gets the entry exclusion filters defined for filtering content to this subscriber.
abstract java.util.List	entryInclusionFilters() Gets the entry inclusion filters defined for filtering content to this subscriber.
abstract java.util.List	fileMimeTypeExclusionFilters() Gets the file MIME type exclusion filters for this user.
abstract java.util.List	fileMimeTypeInclusionFilters() Gets the file MIME type inclusion filters for this user.
abstract java.lang.String	getArchiveReceiveBy() Gets the receive method this subscriber prefers (value or reference).
abstract java.lang.String	getDavUrlType() Sets the type of url.
abstract java.lang.String	getEmailFormat() Gets the email format for this subcriber.
abstract java.lang.String	getMail() Gets the mail address to send to for this subscriber.
abstract java.util.List	nameValueExclusionFilters() Gets the name/value exclusion filters defined for filtering data received by this subscriber identity.
abstract java.util.List	nameValueInclusionFilters() Gets the name/value inclusion filters defined for filtering data received by this subscriber identity.
abstract void	removeEntryExclusionFilter(java.lang.String filter) Remove an entry exclusion filter from this subscriber.
abstract void	removeEntryInclusionFilter(java.lang.String filter) Remove an entry inclusion filter from the subscriber.
abstract void	removeFileMimeTypeExclusionFilter(java.lang.String filter) Remove a file type exclusion filter.
abstract void	removeFileMimeTypeInclusionFilter(java.lang.String filter) Remove a file type inclusion filter.
abstract void	removeFilters() Remove all filters for this subscriber.
abstract void	removeNameValueExclusionFilter(java.lang.String filter) Remove a name/value exclusion filter from the subscriber.
abstract void	removeNameValueInclusionFilter(java.lang.String filter) Remove a name/value inclusion filter from the subscriber.
abstract void	setArchiveReceiveBy(java.lang.String receiveBy) Sets the preferred mechanism for receiving published archives (value or reference).
abstract void	setDavUrlType(java.lang.String type) Sets the type of url.
abstract void	setEmailFormat(java.lang.String emailFormat) Sets the preferred email format for this subscriber.
abstract void	setMail(java.lang.String mail) Sets the mail address to send to for this user.

Methods inherited from interface com.sas.services.information.metadata.SubscriberInterface

getContentDestination, getDeliveryTransport, getMessageQueue, getMessageQueue, getPerson, getQueueName, getSubscribedChannels, setContentDestination, setDeliveryTransport, setMessageQueue, setPerson, setQueueName, validate

Methods inherited from interface com.sas.services.information.metadata.MetadataInterface

add, addAccessControl, addAttribute, addAttributes, addDocument, addExtension, addGroup, addImplementor, addKeyword, addNoteTextStore, addNoteTextStore, addObjectProperty, addObjectProperty, addPermissions, addPrompt, addPropertySet, addRemark, addResponsibleParty, addTransactionListener, addUsedByPrototype, checkin, checkout, commit, copyTo, countAssociatedObjects, delete, deleteAttribute, deleteAttributes, destroy, getAccessControls, getAttribute, getAttributes, getAuthorizationUtil, getCreateDate, getCreatedBy, getDescription, getDocuments, getEntityKey, getEntityURL, getExtensions, getGroups, getGUID, getIdentities, getImplementors, getKeywords, getLockedBy, getModifiedBy, getModifyDate, getNoteTextStore, getNoteTextStores, getNoteTextStoresByRole, getObjectProperties, getParent, getParentPath, getParents, getPath, getPaths, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getPrimaryPropertyGroup, getPrompt, getPrompts, getPropertyBag, getPropertySets, getRemarksList, getReposId, getRepository, getRepositoryEntity, getRepositoryName, getReposKey, getResponsibleParties, getState, getTrackingId, getType, getUsageVersion, getUsedByPrototypes, getUsingPrototype, getVersion, isAuthorized, isCompatible, isDeleted, isDestroyed, isObjectAlive, isReadCompatible, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeDocument, removeExtension, removeGroup, removeImplementor, removeKeyword, removeNoteTextStore, removeObjectProperty, removePermissions, removePrompt, removePropertySet, removeResponsibleParty, removeResponsiblePartyByIdentity, removeUsedByPrototype, rollback, setAttribute, setAttributes, setDeleted, setDescription, setDocuments, setExtensions, setGroups, setGUID, setKeywords, setName, setNoteTextStores, setObjectProperties, setPermission, setPrimaryPropertyGroup, setPrompt, setPrompts, setRemarksList, setRepository, setUsingPrototype, startTransaction, toByteArray, transactionEvent, uncheckout, update, updateFromBag, version

Methods inherited from interface com.sas.services.information.publicobject.PublicObjectInterface

addProcessorInterface, getContainer, getIdentifier, getName, getObjectURI, getPathUrl, getProcessorInterface, getTypeDescriptor

Field Detail

EMAIL_FORMAT_HTML

static final java.lang.String EMAIL_FORMAT_HTML

Email format code: HTML

See Also:

Constant Field Values

EMAIL_FORMAT_TEXT

static final java.lang.String EMAIL_FORMAT_TEXT

Email format code: text

See Also:

Constant Field Values

DEFAULT_EMAIL_FORMAT

static final java.lang.String DEFAULT_EMAIL_FORMAT

The default Email format.

See Also:

Constant Field Values

EMAIL_TYPE

static final java.lang.String EMAIL_TYPE

A value used to indicate that the Email address is being used for a publishing framework subscriber.

See Also:

Constant Field Values

WEBDAV_URL_TYPE_COLLECTION

static final java.lang.String WEBDAV_URL_TYPE_COLLECTION

WebDAV URL type code: collection

See Also:

Constant Field Values

WEBDAV_URL_TYPE_PARENT

static final java.lang.String WEBDAV_URL_TYPE_PARENT

WebDAV URL type code: parent

See Also:

Constant Field Values

DEFAULT_WEBDAV_URL_TYPE

static final java.lang.String DEFAULT_WEBDAV_URL_TYPE

The default WebDAV URL type code.

See Also:

Constant Field Values

Method Detail

getMail

java.lang.String getMail()
                         throws ServiceException,
                                java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

setMail

void setMail(java.lang.String mail)
             throws ServiceException,
                    java.rmi.RemoteException

Sets the mail address to send to for this user.

Parameters:

mail - The mail address

Throws:

ServiceException - if a service level error occurs.

java.rmi.RemoteException - if a network anomaly is encountered.

getEmailFormat

java.lang.String getEmailFormat()
                                throws ServiceException,
                                       java.rmi.RemoteException

Gets the email format for this subcriber. The format will be one of the following:

• EMAIL_FORMAT_HTML
• EMAIL_FORMAT_TEXT

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.

java.rmi.RemoteException - if a network anomaly is encountered.

setEmailFormat

void setEmailFormat(java.lang.String emailFormat)
                    throws ServiceException,
                           java.rmi.RemoteException

Sets the preferred email format for this subscriber. The format must be one of the following:

• EMAIL_FORMAT_HTML
• EMAIL_FORMAT_TEXT

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.

java.rmi.RemoteException - if a network anomaly is encountered.

getArchiveReceiveBy

java.lang.String getArchiveReceiveBy()
                                     throws ServiceException,
                                            java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

setArchiveReceiveBy

void setArchiveReceiveBy(java.lang.String receiveBy)
                         throws ServiceException,
                                java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

nameValueInclusionFilters

java.util.List nameValueInclusionFilters()
                                         throws ServiceException,
                                                java.rmi.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.

java.rmi.RemoteException - in the event of remote object failure.

addNameValueInclusionFilter

void addNameValueInclusionFilter(java.lang.String filter)
                                 throws ServiceException,
                                        java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

removeNameValueInclusionFilter

void removeNameValueInclusionFilter(java.lang.String filter)
                                    throws ServiceException,
                                           java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

nameValueExclusionFilters

java.util.List nameValueExclusionFilters()
                                         throws ServiceException,
                                                java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

addNameValueExclusionFilter

void addNameValueExclusionFilter(java.lang.String filter)
                                 throws ServiceException,
                                        java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

removeNameValueExclusionFilter

void removeNameValueExclusionFilter(java.lang.String filter)
                                    throws ServiceException,
                                           java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

entryExclusionFilters

java.util.List entryExclusionFilters()
                                     throws ServiceException,
                                            java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

addEntryExclusionFilter

void addEntryExclusionFilter(java.lang.String filter)
                             throws ServiceException,
                                    java.rmi.RemoteException

Add an entry exclusion filter to this subscriber.

Parameters:

filter - The new entry exclusion filter.

Throws:

ServiceException - if a service level error occurs.

java.rmi.RemoteException - if a network anomaly is encountered.

removeEntryExclusionFilter

void removeEntryExclusionFilter(java.lang.String filter)
                                throws ServiceException,
                                       java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

entryInclusionFilters

java.util.List entryInclusionFilters()
                                     throws ServiceException,
                                            java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

addEntryInclusionFilter

void addEntryInclusionFilter(java.lang.String filter)
                             throws ServiceException,
                                    java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

removeEntryInclusionFilter

void removeEntryInclusionFilter(java.lang.String filter)
                                throws ServiceException,
                                       java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

fileMimeTypeExclusionFilters

java.util.List fileMimeTypeExclusionFilters()
                                            throws ServiceException,
                                                   java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

addFileMimeTypeExclusionFilter

void addFileMimeTypeExclusionFilter(java.lang.String filter)
                                    throws ServiceException,
                                           java.rmi.RemoteException

Add a file type exclusion filter.

Parameters:

filter - The new file type exclusion filter.

Throws:

ServiceException - if a service level error occurs.

java.rmi.RemoteException - if a network anomaly is encountered.

removeFileMimeTypeExclusionFilter

void removeFileMimeTypeExclusionFilter(java.lang.String filter)
                                       throws ServiceException,
                                              java.rmi.RemoteException

Remove a file type exclusion filter.

Parameters:

filter - The file type exclusion filter to remove.

Throws:

ServiceException - if a service level error occurs.

java.rmi.RemoteException - if a network anomaly is encountered.

fileMimeTypeInclusionFilters

java.util.List fileMimeTypeInclusionFilters()
                                            throws ServiceException,
                                                   java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

addFileMimeTypeInclusionFilter

void addFileMimeTypeInclusionFilter(java.lang.String filter)
                                    throws ServiceException,
                                           java.rmi.RemoteException

Add a file type inclusion filter.

Parameters:

filter - The file type inclusion filter to add.

Throws:

ServiceException - if a service level error occurs.

java.rmi.RemoteException - if a network anomaly is encountered.

removeFileMimeTypeInclusionFilter

void removeFileMimeTypeInclusionFilter(java.lang.String filter)
                                       throws ServiceException,
                                              java.rmi.RemoteException

Remove a file type inclusion filter.

Parameters:

filter - The file type inclusion filter to remove.

Throws:

ServiceException - if a service level error occurs.

java.rmi.RemoteException - if a network anomaly is encountered.

getDavUrlType

java.lang.String getDavUrlType()
                               throws ServiceException,
                                      java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

setDavUrlType

void setDavUrlType(java.lang.String type)
                   throws ServiceException,
                          java.rmi.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.

java.rmi.RemoteException - if a network anomaly is encountered.

removeFilters

void removeFilters()
                   throws ServiceException,
                          java.rmi.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.

java.rmi.RemoteException - if a networking issue is encountered.