|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPortalDefinitionManager
Defines methods to manage PortalDefinition
objects. Multiple
desktops can be associated with a single portal.
"Definitions" can be thought of as objects in the library. Objects in the library are not associated to
any one Desktop. In other words definitions can be placed on zero or more desktops and changes
made in the library (to the definitions) are cascaded down to object on the desktops. If you are
only interested in affecting a single desktop then use the PortalCustomizationManager
and
make changes to the "Instances".
Method Summary | |
---|---|
PortalDefinition |
createPortalDefinition(CustomizationContext customizationContext,
PortalDefinition pd)
Creates a persistent version of a PortalDefinition
from the provided PortalDefinition . |
int |
deletePortalDefinition(CustomizationContext customizationContext,
PortalPath portalPath,
String webapp)
Deletes a PortalDefinition. |
DefinitionCount |
getDefinitionCount(CustomizationContext customizationContext,
boolean _public)
Return a count of all the portal definitions in the system. |
DefinitionCount |
getDefinitionCount(CustomizationContext customizationContext,
String webapp,
boolean _public)
Return a count of all the definitions scoped to a webapp. |
int |
getDesktopDefinitionCount(CustomizationContext customizationContext,
PortalPath portalPath,
String webapp)
Returns the number of DesktopDefinition s under
portal portalPath . |
PortalPath[] |
getDesktopDefinitionPortals(CustomizationContext customizationContext,
DesktopPath desktopPath,
String webapp)
Returns all the PortalPath s that a
DesktopDefinition is a part of. |
DesktopDefinition[] |
getDesktopDefinitions(CustomizationContext customizationContext,
PortalPath portalPath,
int begin,
int end,
String webapp)
Returns DesktopDefinition s in the begin
and end range under the portal portalPath . |
DesktopView[] |
getDesktopViews(CustomizationContext customizationContext,
PortalPath portalPath,
int begin,
int end,
String webapp)
Returns DesktopView s in the begin and
end range under the portal portalPath . |
PortalDefinition |
getPortalDefinition(CustomizationContext customizationContext,
PortalPath portalPath,
String webapp)
Returns a PortalDefinition corresponding to a
PortalPath . |
int |
getPortalDefinitionCount(CustomizationContext customizationContext,
String webapp)
Returns the number of portals for a given webapp. |
PortalDefinition[] |
getPortalDefinitions(CustomizationContext customizationContext,
PortalPath[] portalPaths,
String webapp)
Returns an array of PortalDefinition s corresponding
to an array of PortalPath s. |
SortableFilterablePagedResult<PortalDefinition> |
getPortalDefinitions(CustomizationContext customizationContext,
PortalSearchCriteria criteria,
int pageSize)
Retrieve all the portals for a webapp as a paged object. |
PortalView |
getPortalDefinitionView(CustomizationContext customizationContext,
PortalPath portalPath,
String webapp)
Returns a PortalView corresponding to a
PortalPath . |
PortalView[] |
getPortalDefinitionViews(CustomizationContext customizationContext,
PortalPath[] portalPaths,
String webapp)
Returns an array of PortalView s corresponding
to an array of PortalPath s. |
PortalPath[] |
getPortalPaths(CustomizationContext customizationContext,
int begin,
int end,
String webapp)
Returns an array of PortalPath s in the
begin and end range. |
String[] |
getPortalWebApps(CustomizationContext customizationContext)
Return a set of portal webapps that have at least one shell defined. |
SortableFilterablePagedResult<LocalizationResourceView> |
getVisiblePortalLocalizationResources(CustomizationContext customizationContext,
WebAppSearchCriteria criteria,
int pageSize)
Retrieve the LocalizationResourceViews for all visible portals for a given locale and webapp. |
PortalDefinition[] |
searchPublicPortalDefinitions(CustomizationContext customizationContext,
String webapp,
String partialPortalTitle,
int limit)
Search for public portals given the supplied search string. |
void |
updatePortalDefinition(CustomizationContext customizationContext,
PortalPath portalPath,
PortalDefinition newPd)
Updates a PortalDefinition based on a new PortalDefinition. |
Method Detail |
---|
String[] getPortalWebApps(CustomizationContext customizationContext) throws RemoteException
customizationContext
-
RemoteException
DefinitionCount getDefinitionCount(CustomizationContext customizationContext, boolean _public) throws RemoteException
Return a count of all the portal definitions in the system.
customizationContext
- _public
- if true only return public definitions
RemoteException
DefinitionCount getDefinitionCount(CustomizationContext customizationContext, String webapp, boolean _public) throws RemoteException
Return a count of all the definitions scoped to a webapp.
customizationContext
- webapp
- web app name_public
- if true only return public definitions
RemoteException
int getPortalDefinitionCount(CustomizationContext customizationContext, String webapp) throws RemoteException
webapp
- web application these desktop definitions are scoped to.
RemoteException
PortalDefinition getPortalDefinition(CustomizationContext customizationContext, PortalPath portalPath, String webapp) throws RemoteException, ObjectNotFoundException
Returns a PortalDefinition
corresponding to a
PortalPath
.
customizationContext
- customization information such as preferred
localesportalPath
- PortalPath
webapp
- web application these desktop definitions are scoped to.
PortalDefinition
ObjectNotFoundException
- if no portal is found
RemoteException
PortalView getPortalDefinitionView(CustomizationContext customizationContext, PortalPath portalPath, String webapp) throws RemoteException, ObjectNotFoundException
Returns a PortalView
corresponding to a
PortalPath
.
customizationContext
- customization information such as preferred
localesportalPath
- PortalPath
webapp
- web application these desktop definitions are scoped to.
PortalView
ObjectNotFoundException
- if no category definition is found
RemoteException
PortalPath[] getPortalPaths(CustomizationContext customizationContext, int begin, int end, String webapp) throws RemoteException
Returns an array of PortalPath
s in the
begin
and end
range. If fewer portals
than (begin-end) exist then the former number of portals is
returned. If no definitions are found an empty array is returned.
The implmentation has to ensure that repeated calls to this
method return PortalPath
s in a consistent
order.
customizationContext
- customization information such as preferred
localesbegin
- begin indexend
- end indexwebapp
- web application these desktop definitions are scoped to.
PortalPath
s
RemoteException
PortalDefinition[] getPortalDefinitions(CustomizationContext customizationContext, PortalPath[] portalPaths, String webapp) throws RemoteException, ObjectNotFoundException
Returns an array of PortalDefinition
s corresponding
to an array of PortalPath
s.
customizationContext
- customization information such as preferred
localesportalPaths
- array of PortalPath
s. If null return all portal definitionswebapp
- web application these desktop definitions are scoped to.
PortalDefinition
s
ObjectNotFoundException
- if portal for any key does not exist
RemoteException
PortalView[] getPortalDefinitionViews(CustomizationContext customizationContext, PortalPath[] portalPaths, String webapp) throws RemoteException, ObjectNotFoundException
Returns an array of PortalView
s corresponding
to an array of PortalPath
s.
customizationContext
- customization information such as preferred
localesportalPaths
- array of PortalPath
swebapp
- web application these desktop definitions are scoped to.
PortalView
s
ObjectNotFoundException
- if portal for any key does not exist
RemoteException
int getDesktopDefinitionCount(CustomizationContext customizationContext, PortalPath portalPath, String webapp) throws RemoteException
DesktopDefinition
s under
portal
portalPath
.
portalPath
- PortalPath
webapp
- web application these desktop definitions are scoped to.
PortletDefinition
s under portal
represented by portalPath
RemoteException
DesktopDefinition[] getDesktopDefinitions(CustomizationContext customizationContext, PortalPath portalPath, int begin, int end, String webapp) throws RemoteException
DesktopDefinition
s in the begin
and end
range under the portal portalPath
.
If fewer DesktopDefinition
s than (begin-end) exist
then the former number is returned. If no definitions are
found an empty array is returned.DesktopDefinition
s.DesktopDefinition
s in a consistent
order.
customizationContext
- customization information such as preferred
localesportalPath
- PortalPath
begin
- begin indexend
- end indexwebapp
- web application these desktop definitions are scoped to.
DesktopDefinition
s
RemoteException
DesktopView[] getDesktopViews(CustomizationContext customizationContext, PortalPath portalPath, int begin, int end, String webapp) throws RemoteException, ObjectNotFoundException
DesktopView
s in the begin
and
end
range under the portal portalPath
. If fewer
views than (begin-end) exist then the former number of views is returned.
If no views are found an empty array is returned.DesktopDefinition
s.DesktopView
s in a consistent
order.
customizationContext
- customization information such as preferred
localesportalPath
- PortalPath
begin
- begin indexend
- end indexwebapp
- web application these desktop definitions are scoped to.
DesktopView
s
RemoteException
ObjectNotFoundException
PortalPath[] getDesktopDefinitionPortals(CustomizationContext customizationContext, DesktopPath desktopPath, String webapp) throws RemoteException
PortalPath
s that a
DesktopDefinition
is a part of. Returns an empty array
if the latter does not belong to any portals.
desktopPath
- DesktopPath
webapp
- web application these desktop definitions are scoped to.
PortalPath
s
RemoteException
PortalDefinition createPortalDefinition(CustomizationContext customizationContext, PortalDefinition pd) throws RemoteException, NotEntitledException, MissingDataException, DuplicateObjectException
PortalDefinition
from the provided PortalDefinition
.
customizationContext
- customization information such as preferred
localespd
- PortalDefinition
PortalDefinition
NotEntitledException
- if caller does not have permission for this
operation
MissingDataException
- if data required to create a portal is
missing
DuplicateObjectException
- if this or another webapp already has a portal with the same partial path
RemoteException
int deletePortalDefinition(CustomizationContext customizationContext, PortalPath portalPath, String webapp) throws RemoteException, NotEntitledException
customizationContext
- customization information such as preferred
localesportalPath
- PortalPath for PortalDefinition to be removedwebapp
- web application these desktop definitions are scoped to.
NotEntitledException
- if caller does not have permission for this
operation
RemoteException
void updatePortalDefinition(CustomizationContext customizationContext, PortalPath portalPath, PortalDefinition newPd) throws RemoteException, ObjectNotFoundException, ObjectInUseException, NotEntitledException, MissingDataException
customizationContext
- customization information such as preferred
localesportalPath
- PortalPath to PortalDefinition to be updatednewPd
- new PortalDefinition
ObjectNotFoundException
- if portal does not exist
NotEntitledException
- if caller does not have permission for this
operation
MissingDataException
- if data required to update a portal is
missing
RemoteException
ObjectInUseException
PortalDefinition[] searchPublicPortalDefinitions(CustomizationContext customizationContext, String webapp, String partialPortalTitle, int limit) throws RemoteException
Search for public portals given the supplied search string. Portals with titles
matching the supplied pattern will be returned.
No more than limit
results will be returned; however a smaller number may be
returned.
The implmentation has to ensure that repeated calls to this
method return PortalDefinition
s in a consistent
order.
customizationContext
- customization information such as preferred locales.webapp
- the web application these portal definitions are scoped to.partialPortalTitle
- the search string for portal title match. Note: this string may contain special
'*' and '?' characters, where '*' matches any number of characters and '?' matches any single character.limit
- the maximum result set size. Note the limit may be negative indicating a reverse sort order.
To retrieve all the records specify a limit of zero.
Note: some elements may be pruned because of entitlements.
PortalDefinition
s no greater than limit
in size.
RemoteException
SortableFilterablePagedResult<LocalizationResourceView> getVisiblePortalLocalizationResources(CustomizationContext customizationContext, WebAppSearchCriteria criteria, int pageSize) throws RemoteException
customizationContext
- a customization context with a request and locale defined. Only the first locale is used.criteria
- criteria for the search, including the name of the web application
where the requested resources livepageSize
- number of results to retrieve per page
RemoteException
SortableFilterablePagedResult<PortalDefinition> getPortalDefinitions(CustomizationContext customizationContext, PortalSearchCriteria criteria, int pageSize) throws RemoteException
customizationContext
- a customization context with a request and locale defined. Only the first locale is used.criteria
- criteria for the search, including the name of the web
application and (optional) portal paths to restrict the resultspageSize
- number of results to retrieve per page
SortableFilterablePagedResult
of PortalDefinitions
RemoteException
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |