|
| Metadata |
|
| |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||||
public interface PSPortalPage
A PortalPage gathers and displays information in the Portal, and can be customized.
Attributes of PSPortalPage are:
Associations of PSPortalPage 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(); PSPortalPage myObject = (PSPortalPage) factory.createComplexMetadataObject(objectStore, "PSPortalPage_Object", MetadataObjects.PSPORTALPAGE, "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_LAYOUTCOMPONENTS_NAME
Constant used for the name of the LayoutComponents association. |
static java.lang.String |
ASSOCIATION_PAGEPROFILES_NAME
Constant used for the name of the PageProfiles association. |
static java.lang.String |
ATTRIBUTE_NUMBEROFCOLUMNS_NAME
Constant used for the name of the NumberOfColumns attribute. |
static java.lang.String |
ATTRIBUTE_NUMBEROFROWS_NAME
Constant used for the name of the NumberOfRows attribute. |
static java.lang.String |
ATTRIBUTE_PREFERREDHEIGHT_NAME
Constant used for the name of the PreferredHeight attribute. |
static java.lang.String |
ATTRIBUTE_PREFERREDWIDTH_NAME
Constant used for the name of the PreferredWidth attribute. |
static java.lang.String |
ATTRIBUTE_TYPE_NAME
Constant used for the name of the Type 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 | |
|---|---|
abstract AssociationList |
getLayoutComponents()
Gets the Association list of LayoutComponents |
abstract AssociationList |
getLayoutComponents(boolean fGoToServer)
Gets the Associationlist of LayoutComponents |
abstract double |
getNumberOfColumns()
Gets the double value of NumberOfColumns |
abstract int |
getNumberOfColumnsState()
Gets the Metadata State of NumberOfColumns |
abstract double |
getNumberOfRows()
Gets the double value of NumberOfRows |
abstract int |
getNumberOfRowsState()
Gets the Metadata State of NumberOfRows |
abstract AssociationList |
getPageProfiles()
Gets the Association list of PageProfiles |
abstract AssociationList |
getPageProfiles(boolean fGoToServer)
Gets the Associationlist of PageProfiles |
abstract java.lang.String |
getPreferredHeight()
Gets the String value of PreferredHeight |
abstract int |
getPreferredHeightMaxLength()
Gets the maximum length of PreferredHeight |
abstract int |
getPreferredHeightState()
Gets the Metadata State of PreferredHeight |
abstract java.lang.String |
getPreferredWidth()
Gets the String value of PreferredWidth |
abstract int |
getPreferredWidthMaxLength()
Gets the maximum length of PreferredWidth |
abstract int |
getPreferredWidthState()
Gets the Metadata State of PreferredWidth |
abstract java.lang.String |
getType()
Gets the String value of Type |
abstract int |
getTypeMaxLength()
Gets the maximum length of Type |
abstract int |
getTypeState()
Gets the Metadata State of Type |
abstract void |
initializePredObjects()
(S) Adds the Associated objects to the predObjects which are: |
abstract void |
initializeRequiredObjects()
(S) This initializes the Required Objects(Roles) which are: |
abstract void |
setLayoutComponents(AssociationList list)
Sets the LayoutComponents list to be list. |
abstract void |
setLayoutComponents(AssociationList inObjects,
int state)
Sets the entire LayoutComponents list to match the passed in AssociationList, sets the state of the LayoutComponents |
abstract void |
setNumberOfColumns(double inNumberOfColumns)
Sets the NumberOfColumns value and sets the state to MetadataState.LOCAL. |
abstract void |
setNumberOfColumns(double inNumberOfColumns,
int state)
Sets the NumberOfColumns Metadata State. |
abstract void |
setNumberOfColumns(java.lang.String inNumberOfColumns)
Sets the NumberOfColumns value and sets the state to MetadataState.LOCAL |
abstract void |
setNumberOfColumns(java.lang.String inNumberOfColumns,
int state)
Sets the NumberOfColumns value and Metadata State. |
abstract void |
setNumberOfColumnsState(int state)
Sets the Metadata State of NumberOfColumns. |
abstract void |
setNumberOfRows(double inNumberOfRows)
Sets the NumberOfRows value and sets the state to MetadataState.LOCAL. |
abstract void |
setNumberOfRows(double inNumberOfRows,
int state)
Sets the NumberOfRows Metadata State. |
abstract void |
setNumberOfRows(java.lang.String inNumberOfRows)
Sets the NumberOfRows value and sets the state to MetadataState.LOCAL |
abstract void |
setNumberOfRows(java.lang.String inNumberOfRows,
int state)
Sets the NumberOfRows value and Metadata State. |
abstract void |
setNumberOfRowsState(int state)
Sets the Metadata State of NumberOfRows. |
abstract void |
setPageProfiles(AssociationList list)
Sets the PageProfiles list to be list. |
abstract void |
setPageProfiles(AssociationList inObjects,
int state)
Sets the entire PageProfiles list to match the passed in AssociationList, sets the state of the PageProfiles |
abstract void |
setPreferredHeight(java.lang.String inPreferredHeight)
Sets the PreferredHeight value and sets the state to MetadataState.LOCAL. |
abstract void |
setPreferredHeight(java.lang.String inPreferredHeight,
int state)
Sets the PreferredHeight Metadata State. |
abstract void |
setPreferredHeightState(int state)
Sets the Metadata State of PreferredHeight. |
abstract void |
setPreferredWidth(java.lang.String inPreferredWidth)
Sets the PreferredWidth value and sets the state to MetadataState.LOCAL. |
abstract void |
setPreferredWidth(java.lang.String inPreferredWidth,
int state)
Sets the PreferredWidth Metadata State. |
abstract void |
setPreferredWidthState(int state)
Sets the Metadata State of PreferredWidth. |
abstract void |
setType(java.lang.String inType)
Sets the Type value and sets the state to MetadataState.LOCAL. |
abstract void |
setType(java.lang.String inType,
int state)
Sets the Type Metadata State. |
abstract void |
setTypeState(int state)
Sets the Metadata State of Type. |
| 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_PREFERREDWIDTH_NAME
PreferredWidth: The preferred width of the page. Units are site implementation specific.
static final java.lang.String ATTRIBUTE_PREFERREDHEIGHT_NAME
PreferredHeight: The preferred height of the page. Units are site implementation specific.
static final java.lang.String ATTRIBUTE_NUMBEROFCOLUMNS_NAME
NumberOfColumns: The number of columns that the Page has.
static final java.lang.String ATTRIBUTE_TYPE_NAME
Type: The type of PortalPage designates the general UI capabilities of the page, such as Column or Grid.
static final java.lang.String ATTRIBUTE_NUMBEROFROWS_NAME
NumberOfRows: The number of rows that the page has. This is optional for a PortalPage with a type of Column, but required for a PortalPage with a type of Grid.
static final java.lang.String ASSOCIATION_LAYOUTCOMPONENTS_NAME
LayoutComponents: The LayoutComponent that specifies the UI layout of the PortalPage.
static final java.lang.String ASSOCIATION_PAGEPROFILES_NAME
PageProfiles: The portal profiles associated with this page.
| Method Detail |
|---|
void initializeRequiredObjects()
throws java.rmi.RemoteException
initializeRequiredObjects in interface MdObjectBaseUtilinitializeRequiredObjects in interface PrimaryTypeinitializeRequiredObjects in interface Rootjava.rmi.RemoteException - If error connecting/communicating to/with remote object.
void initializePredObjects()
throws java.rmi.RemoteException
initializePredObjects in interface MdObjectBaseinitializePredObjects in interface PrimaryTypeinitializePredObjects in interface Rootjava.rmi.RemoteException - If error connecting/communicating to/with remote object.
java.lang.String getPreferredWidth()
throws java.rmi.RemoteException
String value of PreferredWidth
PreferredWidth
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
int getPreferredWidthState()
throws java.rmi.RemoteException
PreferredWidth
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
int getPreferredWidthMaxLength()
throws java.rmi.RemoteException
PreferredWidth
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
java.lang.String getPreferredHeight()
throws java.rmi.RemoteException
String value of PreferredHeight
PreferredHeight
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
int getPreferredHeightState()
throws java.rmi.RemoteException
PreferredHeight
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
int getPreferredHeightMaxLength()
throws java.rmi.RemoteException
PreferredHeight
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
double getNumberOfColumns()
throws java.rmi.RemoteException
double value of NumberOfColumns
NumberOfColumns
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
int getNumberOfColumnsState()
throws java.rmi.RemoteException
NumberOfColumns
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
java.lang.String getType()
throws java.rmi.RemoteException
String value of Type
Type
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
int getTypeState()
throws java.rmi.RemoteException
Type
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
int getTypeMaxLength()
throws java.rmi.RemoteException
Type
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
double getNumberOfRows()
throws java.rmi.RemoteException
double value of NumberOfRows
NumberOfRows
java.rmi.RemoteException - If error connecting/communicating to/with remote object.
int getNumberOfRowsState()
throws java.rmi.RemoteException
NumberOfRows
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 getPageProfiles()
throws java.rmi.RemoteException,
MdException
PageProfiles
PageProfiles 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 getPageProfiles(boolean fGoToServer)
throws java.rmi.RemoteException,
MdException
PageProfiles
fGoToServer - boolean Get the value from the server.
PageProfiles 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 setPreferredWidth(java.lang.String inPreferredWidth)
throws java.rmi.RemoteException
PreferredWidth value and sets the state to MetadataState.LOCAL.
inPreferredWidth - String
java.rmi.RemoteException - If error communicating with remote object.
void setPreferredWidth(java.lang.String inPreferredWidth,
int state)
throws java.rmi.RemoteException
PreferredWidth Metadata State.
inPreferredWidth - Stringstate - int
java.rmi.RemoteException - If error communicating with remote object.
void setPreferredWidthState(int state)
throws java.rmi.RemoteException
PreferredWidth.
state - int
java.rmi.RemoteException - If error communicating with remote object.
void setPreferredHeight(java.lang.String inPreferredHeight)
throws java.rmi.RemoteException
PreferredHeight value and sets the state to MetadataState.LOCAL.
inPreferredHeight - String
java.rmi.RemoteException - If error communicating with remote object.
void setPreferredHeight(java.lang.String inPreferredHeight,
int state)
throws java.rmi.RemoteException
PreferredHeight Metadata State.
inPreferredHeight - Stringstate - int
java.rmi.RemoteException - If error communicating with remote object.
void setPreferredHeightState(int state)
throws java.rmi.RemoteException
PreferredHeight.
state - int
java.rmi.RemoteException - If error communicating with remote object.
void setNumberOfColumns(double inNumberOfColumns)
throws java.rmi.RemoteException
NumberOfColumns value and sets the state to MetadataState.LOCAL.
inNumberOfColumns - double
java.rmi.RemoteException - If error communicating with remote object.
void setNumberOfColumns(double inNumberOfColumns,
int state)
throws java.rmi.RemoteException
NumberOfColumns Metadata State.
inNumberOfColumns - doublestate - int
java.rmi.RemoteException - If error communicating with remote object.
void setNumberOfColumns(java.lang.String inNumberOfColumns)
throws java.rmi.RemoteException
NumberOfColumns value and sets the state to MetadataState.LOCAL
inNumberOfColumns - String
java.rmi.RemoteException - If error communicating with remote object.
void setNumberOfColumns(java.lang.String inNumberOfColumns,
int state)
throws java.rmi.RemoteException
NumberOfColumns value and Metadata State.
inNumberOfColumns - Stringstate - int
java.rmi.RemoteException - If error communicating with remote object.
void setNumberOfColumnsState(int state)
throws java.rmi.RemoteException
NumberOfColumns.
state - int
java.rmi.RemoteException - If error communicating with remote object.
void setType(java.lang.String inType)
throws java.rmi.RemoteException
Type value and sets the state to MetadataState.LOCAL.
inType - String
java.rmi.RemoteException - If error communicating with remote object.
void setType(java.lang.String inType,
int state)
throws java.rmi.RemoteException
Type Metadata State.
inType - Stringstate - int
java.rmi.RemoteException - If error communicating with remote object.
void setTypeState(int state)
throws java.rmi.RemoteException
Type.
state - int
java.rmi.RemoteException - If error communicating with remote object.
void setNumberOfRows(double inNumberOfRows)
throws java.rmi.RemoteException
NumberOfRows value and sets the state to MetadataState.LOCAL.
inNumberOfRows - double
java.rmi.RemoteException - If error communicating with remote object.
void setNumberOfRows(double inNumberOfRows,
int state)
throws java.rmi.RemoteException
NumberOfRows Metadata State.
inNumberOfRows - doublestate - int
java.rmi.RemoteException - If error communicating with remote object.
void setNumberOfRows(java.lang.String inNumberOfRows)
throws java.rmi.RemoteException
NumberOfRows value and sets the state to MetadataState.LOCAL
inNumberOfRows - String
java.rmi.RemoteException - If error communicating with remote object.
void setNumberOfRows(java.lang.String inNumberOfRows,
int state)
throws java.rmi.RemoteException
NumberOfRows value and Metadata State.
inNumberOfRows - Stringstate - int
java.rmi.RemoteException - If error communicating with remote object.
void setNumberOfRowsState(int state)
throws java.rmi.RemoteException
NumberOfRows.
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 setPageProfiles(AssociationList list)
throws java.rmi.RemoteException
PageProfiles list to be list. Objects of which can be of type:
list - AssociationList
java.rmi.RemoteException - If error communicating with remote object.
void setPageProfiles(AssociationList inObjects,
int state)
throws java.rmi.RemoteException
inObjects - AssociationListstate - int
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 | |||||||||||||