|
Metadata |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PSPortlet
A Web component that is managed by a Web application and that is aggregated with other portlets to form a page within the application. Portlets can process requests from the user and generate dynamic content.
Attributes of PSPortlet are:
Associations of PSPortlet 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(); PSPortlet myObject = (PSPortlet) factory.createComplexMetadataObject(objectStore, "PSPortlet_Object", MetadataObjects.PSPORTLET, "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_ASSOCIATEDCONTENTCOLLECTION_NAME
Constant used for the name of the AssociatedContentCollection association. |
static java.lang.String |
ASSOCIATION_LAYOUTCOMPONENTS_NAME
Constant used for the name of the LayoutComponents association. |
static java.lang.String |
ATTRIBUTE_PORTLETTYPE_NAME
Constant used for the name of the portletType 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 | |
---|---|
Tree |
getAssociatedContentCollection()
Gets the Tree for AssociatedContentCollection |
AssociationList |
getAssociatedContentCollections()
Gets the Association list of AssociatedContentCollections |
AssociationList |
getAssociatedContentCollections(boolean fGoToServer)
Gets the Associationlist of AssociatedContentCollections |
AssociationList |
getLayoutComponents()
Gets the AssociationList of LayoutComponents |
AssociationList |
getLayoutComponents(boolean fGoToServer)
Gets the Associationlist of LayoutComponents |
java.lang.String |
getportletType()
Gets the String value of portletType |
int |
getportletTypeMaxLength()
Gets the maximum length of portletType |
int |
getportletTypeState()
Gets the Metadata State of portletType |
void |
initializePredObjects()
(S) Adds the Associated objects to the predObjects which are: LayoutComponents |
void |
initializeRequiredObjects()
(S) This initializes the Required Objects(Roles) which are: |
void |
setAssociatedContentCollection(Tree inObject)
Sets the AssociatedContentCollections list 0th element to be inObject . |
void |
setAssociatedContentCollections(AssociationList list)
Sets the AssociatedContentCollections list to be list . |
void |
setAssociatedContentCollections(AssociationList list,
int state)
Sets the AssociatedContentCollections list to be list . |
void |
setLayoutComponents(AssociationList list)
Sets the LayoutComponents list to be list . |
void |
setLayoutComponents(AssociationList inObjects,
int state)
Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList |
void |
setportletType(java.lang.String inportletType)
Sets the portletType value and sets the state to MetadataState.LOCAL. |
void |
setportletType(java.lang.String inportletType,
int state)
Sets the portletType Metadata State. |
void |
setportletTypeState(int state)
Sets the Metadata State of portletType . |
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_PORTLETTYPE_NAME
portletType: A description of the functionality of the task the Portlet performs.
static final java.lang.String ASSOCIATION_LAYOUTCOMPONENTS_NAME
LayoutComponents: The LayoutComponent that specifies the layout of the Portlets on a PortalPage
static final java.lang.String ASSOCIATION_ASSOCIATEDCONTENTCOLLECTION_NAME
AssociatedContentCollection: The tree that contains hierarchical information pertaining to this object. For example, Portal collections would be stored in a tree hierarchy and associated to the PSPortlet using this association.
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
LayoutComponents
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 getportletType() throws java.rmi.RemoteException
String
value of portletType
portletType
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getportletTypeState() throws java.rmi.RemoteException
portletType
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getportletTypeMaxLength() throws java.rmi.RemoteException
portletType
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.AssociationList getLayoutComponents() throws java.rmi.RemoteException, MdException
LayoutComponents
LayoutComponents
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 getAssociatedContentCollections() throws java.rmi.RemoteException, MdException
AssociatedContentCollections
AssociatedContentCollections
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.Tree getAssociatedContentCollection() throws java.rmi.RemoteException, MdException
Tree
for AssociatedContentCollection
Tree
( null
if not set ) of AssociatedContentCollection
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 getLayoutComponents(boolean fGoToServer) throws java.rmi.RemoteException, MdException
LayoutComponents
fGoToServer
- boolean Get the value from the server.
LayoutComponents
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 getAssociatedContentCollections(boolean fGoToServer) throws java.rmi.RemoteException, MdException
AssociatedContentCollections
fGoToServer
- boolean Get the value from the server.
AssociatedContentCollections
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 setportletType(java.lang.String inportletType) throws java.rmi.RemoteException
portletType
value and sets the state to MetadataState.LOCAL.
inportletType
- String
java.rmi.RemoteException
- If error communicating with remote object.void setportletType(java.lang.String inportletType, int state) throws java.rmi.RemoteException
portletType
Metadata State.
inportletType
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setportletTypeState(int state) throws java.rmi.RemoteException
portletType
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setLayoutComponents(AssociationList list) throws java.rmi.RemoteException
LayoutComponents
list to be list
. Objects of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setLayoutComponents(AssociationList inObjects, int state) throws java.rmi.RemoteException
inObjects
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setAssociatedContentCollections(AssociationList list) throws java.rmi.RemoteException
AssociatedContentCollections
list to be list
. Objects of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setAssociatedContentCollections(AssociationList list, int state) throws java.rmi.RemoteException
AssociatedContentCollections
list to be list
. Objects of which can be of type:
list
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setAssociatedContentCollection(Tree inObject) throws java.rmi.RemoteException
AssociatedContentCollections
list 0th element to be inObject
.
inObject
- Tree
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 |