|
Metadata |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITSubscriber
A subscriber profile is used to control how published content is delivered to a user. Typical delivery mechanisms are mail, message queue or none. None is used by Portal users who will check the channel for new archived packages and view them on demand, rather than having them delivered at publication time.
Attributes of ITSubscriber are:
Associations of ITSubscriber are:
factory
create methods. // 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(); ITSubscriber myObject = (ITSubscriber) factory.createComplexMetadataObject(objectStore, "ITSubscriber_Object", MetadataObjects.ITSUBSCRIBER, "AAAAAAAA"); myObject.updateMetadataAll(); // Write object to server objectStore.dispose(); // dispose of the object store if it is no longer needed
MdOMIUtil
.
updateMetadataAll
method.
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.
Field Summary | |
---|---|
static java.lang.String |
ASSOCIATION_CONTENTDESTINATION_NAME
Constant used for the name of the ContentDestination association. |
static java.lang.String |
ASSOCIATION_PROFILEOWNER_NAME
Constant used for the name of the ProfileOwner association. |
static java.lang.String |
ASSOCIATION_SUBSCRIBEDCHANNELS_NAME
Constant used for the name of the SubscribedChannels association. |
static java.lang.String |
ASSOCIATION_SUBSCRIBEREMAIL_NAME
Constant used for the name of the SubscriberEmail association. |
static java.lang.String |
ATTRIBUTE_DELIVERYTRANSPORT_NAME
Constant used for the name of the DeliveryTransport attribute. |
static java.lang.String |
ATTRIBUTE_QUEUENAME_NAME
Constant used for the name of the QueueName attribute. |
static java.lang.String |
ATTRIBUTE_URL_NAME
Constant used for the name of the URL attribute. |
Fields inherited from interface com.sas.metadata.remote.PrimaryType |
---|
ASSOCIATION_FAVORITESCONTAINERS_NAME, ATTRIBUTE_ISHIDDEN_NAME, ATTRIBUTE_PUBLICTYPE_NAME |
Fields inherited from interface com.sas.metadata.remote.MdObjectBase |
---|
ATTRIBUTE_DESC_NAME, ATTRIBUTE_ID_NAME, ATTRIBUTE_METADATACREATED_NAME, ATTRIBUTE_METADATAUPDATED_NAME, ATTRIBUTE_NAME_NAME |
Method Summary | |
---|---|
Directory |
getContentDestination()
Gets the Directory for ContentDestination |
AssociationList |
getContentDestinations()
Gets the AssociationList of ContentDestinations |
AssociationList |
getContentDestinations(boolean fGoToServer)
Gets the Associationlist of ContentDestinations |
java.lang.String |
getDeliveryTransport()
Gets the String value of DeliveryTransport |
int |
getDeliveryTransportMaxLength()
Gets the maximum length of DeliveryTransport |
int |
getDeliveryTransportState()
Gets the Metadata State of DeliveryTransport |
Person |
getProfileOwner()
Gets the Person for ProfileOwner |
AssociationList |
getProfileOwners()
Gets the AssociationList of ProfileOwners |
AssociationList |
getProfileOwners(boolean fGoToServer)
Gets the Associationlist of ProfileOwners |
java.lang.String |
getQueueName()
Gets the String value of QueueName |
int |
getQueueNameMaxLength()
Gets the maximum length of QueueName |
int |
getQueueNameState()
Gets the Metadata State of QueueName |
AssociationList |
getSubscribedChannels()
Gets the AssociationList of SubscribedChannels |
AssociationList |
getSubscribedChannels(boolean fGoToServer)
Gets the Associationlist of SubscribedChannels |
Email |
getSubscriberEmail()
Gets the Email for SubscriberEmail |
AssociationList |
getSubscriberEmails()
Gets the AssociationList of SubscriberEmails |
AssociationList |
getSubscriberEmails(boolean fGoToServer)
Gets the Associationlist of SubscriberEmails |
java.lang.String |
getURL()
Gets the String value of URL |
int |
getURLMaxLength()
Gets the maximum length of URL |
int |
getURLState()
Gets the Metadata State of URL |
void |
initializePredObjects()
(S) Adds the Associated objects to the predObjects which are: ContentDestination ProfileOwner SubscribedChannels SubscriberEmail |
void |
initializeRequiredObjects()
(S) This initializes the Required Objects(Roles) which are: |
void |
setContentDestination(Directory inObject)
Sets the ContentDestinations list 0th element to be inObject . |
void |
setContentDestinations(AssociationList list)
Sets the ContentDestinations list to be list . |
void |
setContentDestinations(AssociationList list,
int state)
Sets the ContentDestinations list to be list . |
void |
setDeliveryTransport(java.lang.String inDeliveryTransport)
Sets the DeliveryTransport value and sets the state to MetadataState.LOCAL. |
void |
setDeliveryTransport(java.lang.String inDeliveryTransport,
int state)
Sets the DeliveryTransport Metadata State. |
void |
setDeliveryTransportState(int state)
Sets the Metadata State of DeliveryTransport . |
void |
setProfileOwner(Person inObject)
Sets the ProfileOwners list 0th element to be inObject . |
void |
setProfileOwners(AssociationList list)
Sets the ProfileOwners list to be list . |
void |
setProfileOwners(AssociationList list,
int state)
Sets the ProfileOwners list to be list . |
void |
setQueueName(java.lang.String inQueueName)
Sets the QueueName value and sets the state to MetadataState.LOCAL. |
void |
setQueueName(java.lang.String inQueueName,
int state)
Sets the QueueName Metadata State. |
void |
setQueueNameState(int state)
Sets the Metadata State of QueueName . |
void |
setSubscribedChannels(AssociationList list)
Sets the SubscribedChannels list to be list . |
void |
setSubscribedChannels(AssociationList inObjects,
int state)
Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList |
void |
setSubscriberEmail(Email inObject)
Sets the SubscriberEmails list 0th element to be inObject . |
void |
setSubscriberEmails(AssociationList list)
Sets the SubscriberEmails list to be list . |
void |
setSubscriberEmails(AssociationList list,
int state)
Sets the SubscriberEmails list to be list . |
void |
setURL(java.lang.String inURL)
Sets the URL value and sets the state to MetadataState.LOCAL. |
void |
setURL(java.lang.String inURL,
int state)
Sets the URL Metadata State. |
void |
setURLState(int state)
Sets the Metadata State of URL . |
Methods inherited from interface com.sas.metadata.remote.PrimaryType |
---|
getFavoritesContainers, getFavoritesContainers, getIsHidden, getIsHiddenState, getPublicType, getPublicTypeMaxLength, getPublicTypeState, setFavoritesContainers, setFavoritesContainers, setIsHidden, setIsHidden, setIsHidden, setIsHidden, setIsHiddenState, setPublicType, setPublicType, setPublicTypeState |
Methods inherited from interface com.sas.metadata.remote.MdObjectBaseXML |
---|
closeUpdateMetadataXML, createEmptyXML, createObjectRefreshXML, createObjectXML, createObjectXML, createUpdateAssociationXML, createUpdateAssociationXML, createUpdateSimpleXML, doCreateUpdateXML, getUpdateSimpleSubstring, updateMetadataAll |
Field Detail |
---|
static final java.lang.String ATTRIBUTE_QUEUENAME_NAME
QueueName: Message queue name for content delivery to this subscriber.
static final java.lang.String ATTRIBUTE_DELIVERYTRANSPORT_NAME
DeliveryTransport: String containing 'email', 'queue', or 'none'. Instructs the publishing system that delivery mechanism to use to deliver content to the user.
static final java.lang.String ATTRIBUTE_URL_NAME
URL: A relative URL for a DAV collection to put content for this subscriber.
static final java.lang.String ASSOCIATION_CONTENTDESTINATION_NAME
ContentDestination: The directorywhere content is published for this subscriber.
static final java.lang.String ASSOCIATION_PROFILEOWNER_NAME
ProfileOwner: The person for whom this subscriber profile has been defined.
static final java.lang.String ASSOCIATION_SUBSCRIBEDCHANNELS_NAME
SubscribedChannels: The channels for this subscription profile.
static final java.lang.String ASSOCIATION_SUBSCRIBEREMAIL_NAME
SubscriberEmail: Email address for a content subscriber.
Method Detail |
---|
void initializeRequiredObjects() throws java.rmi.RemoteException
initializeRequiredObjects
in interface MdObjectBaseUtil
initializeRequiredObjects
in interface PrimaryType
initializeRequiredObjects
in interface Root
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.void initializePredObjects() throws java.rmi.RemoteException
ContentDestination
ProfileOwner
SubscribedChannels
SubscriberEmail
initializePredObjects
in interface MdObjectBase
initializePredObjects
in interface PrimaryType
initializePredObjects
in interface Root
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.java.lang.String getQueueName() throws java.rmi.RemoteException
String
value of QueueName
QueueName
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getQueueNameState() throws java.rmi.RemoteException
QueueName
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getQueueNameMaxLength() throws java.rmi.RemoteException
QueueName
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.java.lang.String getDeliveryTransport() throws java.rmi.RemoteException
String
value of DeliveryTransport
DeliveryTransport
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getDeliveryTransportState() throws java.rmi.RemoteException
DeliveryTransport
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getDeliveryTransportMaxLength() throws java.rmi.RemoteException
DeliveryTransport
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.java.lang.String getURL() throws java.rmi.RemoteException
String
value of URL
URL
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getURLState() throws java.rmi.RemoteException
URL
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getURLMaxLength() throws java.rmi.RemoteException
URL
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.AssociationList getContentDestinations() throws java.rmi.RemoteException, MdException
ContentDestinations
ContentDestinations
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
Directory getContentDestination() throws java.rmi.RemoteException, MdException
Directory
for ContentDestination
Directory
( null
if not set) of ContentDestination
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getProfileOwners() throws java.rmi.RemoteException, MdException
ProfileOwners
ProfileOwners
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
Person getProfileOwner() throws java.rmi.RemoteException, MdException
Person
for ProfileOwner
Person
( null
if not set) of ProfileOwner
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getSubscribedChannels() throws java.rmi.RemoteException, MdException
SubscribedChannels
SubscribedChannels
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getSubscriberEmails() throws java.rmi.RemoteException, MdException
SubscriberEmails
SubscriberEmails
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
Email getSubscriberEmail() throws java.rmi.RemoteException, MdException
Email
for SubscriberEmail
Email
( null
if not set) of SubscriberEmail
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getContentDestinations(boolean fGoToServer) throws java.rmi.RemoteException, MdException
ContentDestinations
fGoToServer
- boolean Get the value from the server.
ContentDestinations
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getProfileOwners(boolean fGoToServer) throws java.rmi.RemoteException, MdException
ProfileOwners
fGoToServer
- boolean Get the value from the server.
ProfileOwners
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getSubscribedChannels(boolean fGoToServer) throws java.rmi.RemoteException, MdException
SubscribedChannels
fGoToServer
- boolean Get the value from the server.
SubscribedChannels
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getSubscriberEmails(boolean fGoToServer) throws java.rmi.RemoteException, MdException
SubscriberEmails
fGoToServer
- boolean Get the value from the server.
SubscriberEmails
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.void setQueueName(java.lang.String inQueueName) throws java.rmi.RemoteException
QueueName
value and sets the state to MetadataState.LOCAL.
inQueueName
- String
java.rmi.RemoteException
- If error communicating with remote object.void setQueueName(java.lang.String inQueueName, int state) throws java.rmi.RemoteException
QueueName
Metadata State.
inQueueName
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setQueueNameState(int state) throws java.rmi.RemoteException
QueueName
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setDeliveryTransport(java.lang.String inDeliveryTransport) throws java.rmi.RemoteException
DeliveryTransport
value and sets the state to MetadataState.LOCAL.
inDeliveryTransport
- String
java.rmi.RemoteException
- If error communicating with remote object.void setDeliveryTransport(java.lang.String inDeliveryTransport, int state) throws java.rmi.RemoteException
DeliveryTransport
Metadata State.
inDeliveryTransport
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setDeliveryTransportState(int state) throws java.rmi.RemoteException
DeliveryTransport
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setURL(java.lang.String inURL) throws java.rmi.RemoteException
URL
value and sets the state to MetadataState.LOCAL.
inURL
- String
java.rmi.RemoteException
- If error communicating with remote object.void setURL(java.lang.String inURL, int state) throws java.rmi.RemoteException
URL
Metadata State.
inURL
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setURLState(int state) throws java.rmi.RemoteException
URL
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setContentDestinations(AssociationList list) throws java.rmi.RemoteException
ContentDestinations
list to be list
. Object of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setContentDestinations(AssociationList list, int state) throws java.rmi.RemoteException
ContentDestinations
list to be list
. Object of which can be of type:
list
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setContentDestination(Directory inObject) throws java.rmi.RemoteException
ContentDestinations
list 0th element to be inObject
.
inObject
- Directory
java.rmi.RemoteException
- If error communicating with remote object.void setProfileOwners(AssociationList list) throws java.rmi.RemoteException
ProfileOwners
list to be list
. Object of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setProfileOwners(AssociationList list, int state) throws java.rmi.RemoteException
ProfileOwners
list to be list
. Object of which can be of type:
list
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setProfileOwner(Person inObject) throws java.rmi.RemoteException
ProfileOwners
list 0th element to be inObject
.
inObject
- Person
java.rmi.RemoteException
- If error communicating with remote object.void setSubscribedChannels(AssociationList list) throws java.rmi.RemoteException
SubscribedChannels
list to be list
. Objects of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setSubscribedChannels(AssociationList inObjects, int state) throws java.rmi.RemoteException
inObjects
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setSubscriberEmails(AssociationList list) throws java.rmi.RemoteException
SubscriberEmails
list to be list
. Object of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setSubscriberEmails(AssociationList list, int state) throws java.rmi.RemoteException
SubscriberEmails
list to be list
. Object of which can be of type:
list
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setSubscriberEmail(Email inObject) throws java.rmi.RemoteException
SubscriberEmails
list 0th element to be inObject
.
inObject
- Email
java.rmi.RemoteException
- If error communicating with remote object.
|
Metadata |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |