|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ControlInterface
public interface PlaceholderManagerControl
A custom Java Control used to manage ad placeholders.
PlaceholderModel
Method Summary | |
---|---|
PlaceholderModel |
getPlaceholder(String placeholderUri, ResourceContext context) Returns a PlaceholderModel representing the placeholder of the passed in uri. |
SortableFilterablePagedResult<String> |
getPlaceholderNames(int pageSize, ResourceContext context) Returns a PagedResult of String s of all the PlaceholderModel names within the system, in arbitrary order. |
SortableFilterablePagedResult<PlaceholderModel> |
getPlaceholders(int pageSize, ResourceContext context) Returns a PagedResult of all the PlaceholderModel objects within the system, in arbitrary order. |
SortableFilterablePagedResult<ToolQueryDefinitionModel> |
getQueryDefinitions(PlaceholderModel pm, int pageSize, ResourceContext context) Returns a PagedResult of the ToolQueryDefinitionModel objects that wrap the QueryDefinitionModel objects within a given PlaceholderModel, in arbitrary order. |
void |
setPlaceholder(PlaceholderModel model, ResourceContext context) Persists the given PlaceholderModel . |
void |
setPlaceholder(String placeholderUri, PlaceholderModel model, boolean create, ResourceContext context) Persists the given PlaceholderModel . |
Method Detail |
---|
SortableFilterablePagedResult<PlaceholderModel> getPlaceholders(int pageSize, ResourceContext context) throws com.bea.p13n.management.data.repository.PersistenceException, com.bea.p13n.entitlements.common.PolicyRefException, org.apache.xmlbeans.XmlException
PagedResult
of all the PlaceholderModel
objects within the system, in arbitrary order. Returns an empty list if no PlaceholderModel
objects are defined.pageSize
- the int page size for the PagedResult
context
- the resource contextPagedResult
of PlaceholderModel
objectscom.bea.p13n.management.data.repository.PersistenceException
- if an error occurs while trying to query for the model datacom.bea.p13n.entitlements.common.PolicyRefException
- if an error occurs while checking DA rightsorg.apache.xmlbeans.XmlException
- if an error occurs while parsing the model dataPagedResult
, PlaceholderModel
SortableFilterablePagedResult<String> getPlaceholderNames(int pageSize, ResourceContext context) throws com.bea.p13n.management.data.repository.PersistenceException, com.bea.p13n.entitlements.common.PolicyRefException, org.apache.xmlbeans.XmlException
PagedResult
of String
s of all the PlaceholderModel
names within the system, in arbitrary order. Returns an empty list if no PlaceholderModel
objects are defined.pageSize
- the int page size for the PagedResult
context
- the resource contextPagedResult
of String
s representing the PlaceholderModel
namescom.bea.p13n.management.data.repository.PersistenceException
- if an error occurs while trying to query for the model datacom.bea.p13n.entitlements.common.PolicyRefException
- if an error occurs while checking DA rightsorg.apache.xmlbeans.XmlException
- if an error occurs while parsing the model dataPagedResult
PlaceholderModel getPlaceholder(String placeholderUri, ResourceContext context) throws com.bea.p13n.management.data.repository.PersistenceException, com.bea.p13n.entitlements.common.PolicyRefException, org.apache.xmlbeans.XmlException
PlaceholderModel
representing the placeholder of the passed in uri. Returns null if the placeholder does not exist.placeholderUri
- the string URI of the placeholder.context
- the resource contextPlaceholderModel
representing the placeholder of the passed in uricom.bea.p13n.management.data.repository.PersistenceException
- if an error occurs while trying to query for the model datacom.bea.p13n.entitlements.common.PolicyRefException
- if an error occurs while checking DA rightsorg.apache.xmlbeans.XmlException
- if an error occurs while parsing the model dataPlaceholderModel
void setPlaceholder(PlaceholderModel model, ResourceContext context) throws IllegalArgumentException, com.bea.p13n.management.data.repository.MessageException, com.bea.p13n.management.data.repository.PersistenceException, com.bea.p13n.entitlements.common.PolicyRefException, org.apache.xmlbeans.XmlException
PlaceholderModel
. Any existing placholder at the given placeholderUri will be replaced by the new one.model
- a PlaceholderModel
representing the placeholdercontext
- the resource contextIllegalArgumentException
- if create=false and the placeholder you are trying to replace does not exist at the given placeholderUri.com.bea.p13n.management.data.repository.MessageException
- if an error occurs while persisting model datacom.bea.p13n.management.data.repository.PersistenceException
- if an error occurs while trying to query for model data or persist model datacom.bea.p13n.entitlements.common.PolicyRefException
- if an error occurs while checking DA rightsorg.apache.xmlbeans.XmlException
- if an error occurs while parsing the model datavoid setPlaceholder(String placeholderUri, PlaceholderModel model, boolean create, ResourceContext context) throws IllegalArgumentException, com.bea.p13n.management.data.repository.MessageException, com.bea.p13n.management.data.repository.PersistenceException, com.bea.p13n.entitlements.common.PolicyRefException, org.apache.xmlbeans.XmlException
PlaceholderModel
. Any existing placholder at the given placeholderUri will be replaced by the new one.placeholderUri
- the string URI of the placeholder. Cannot be null.model
- a PlaceholderModel
representing the placeholdercreate
- if true then create the placeholder if it does not exist. If false then do not create the placeholder if it does not exist. In both cases, an existing placeholder will be replaced with the new one.context
- the resource contextIllegalArgumentException
- if create=false and the placeholder you are trying to replace does not exist at the given placeholderUri.com.bea.p13n.management.data.repository.MessageException
- if an error occurs while persisting model datacom.bea.p13n.management.data.repository.PersistenceException
- if an error occurs while trying to query for model data or persist model datacom.bea.p13n.entitlements.common.PolicyRefException
- if an error occurs while checking DA rightsorg.apache.xmlbeans.XmlException
- if an error occurs while parsing the model dataSortableFilterablePagedResult<ToolQueryDefinitionModel> getQueryDefinitions(PlaceholderModel pm, int pageSize, ResourceContext context) throws com.bea.p13n.management.data.repository.PersistenceException, com.bea.p13n.entitlements.common.PolicyRefException, org.apache.xmlbeans.XmlException
PagedResult
of the ToolQueryDefinitionModel
objects that wrap the QueryDefinitionModel
objects within a given PlaceholderModel, in arbitrary order. Returns an empty list if no QueryDefinitionModel
objects are defined.pm
- the PlaceholderModel
to querypageSize
- the int page size for the PagedResult
context
- the resource contextPagedResult
of QueryDefinitionModel
objectscom.bea.p13n.management.data.repository.PersistenceException
- if an error occurs while trying to query for the model datacom.bea.p13n.entitlements.common.PolicyRefException
- if an error occurs while checking DA rightsorg.apache.xmlbeans.XmlException
- if an error occurs while parsing the model dataPagedResult
, PlaceholderModel
, QueryDefinitionModel
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.