|
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 IMarkupDefinitionManager
These methods are generally intended for internal Oracle use only.
This is the primary interface for performing persistent store operations
on MarkupDefinitions
. In general this interface provides coarse grain
getters and fine grain setters.
It is important to note that all methods on this interface are fully internationalized and entitled. All titles and descriptions on the objects returned by these methods are internationalized to the preferred locale. Also, all methods are entitled, meaning if the caller does not have the required credentials the method may return a subset of the actual list or be unable to perform the specified function.
Method Summary | |
---|---|
MarkupDefinition |
createMarkupDefinition(CustomizationContext customizationContext,
MarkupDefinition markupDefinition)
Creates a new MarkupView Definition with its placeholders. |
void |
deleteMarkupDefinition(CustomizationContext customizationContext,
MarkupDefinitionId markupDefinitionId)
Delete a markup definition. |
MarkupDefinition |
getMarkupDefinition(CustomizationContext customizationContext,
MarkupDefinitionId markupDefinitionId)
Getter for returning a single MarkupDefinition object given a supplied markup
definition identifier. |
MarkupDefinition |
getMarkupDefinition(CustomizationContext customizationContext,
String markupName,
String webAppName)
Getter for returning a single MarkupDefinition object given a supplied markup
name. |
MarkupDefinition |
getMarkupDefinitionFromFile(CustomizationContext customizationContext,
String markupFile,
String webAppName)
Getter for returning a single MarkupDefinition object given a supplied markup file
name. |
MarkupDefinition[] |
getMarkupDefinitions(CustomizationContext customizationContext,
String webapp)
Getter for returning a list of all MarkupDefinitions scoped to the supplied webapp. |
MarkupView |
getMarkupView(CustomizationContext customizationContext,
MarkupDefinitionId markupDefinitionId)
Getter for returning an immutable deep MarkupView. |
void |
updateMarkupDefinition(CustomizationContext customizationContext,
MarkupDefinition markupDefinition)
Update the markup definition with the new data. |
Method Detail |
---|
MarkupView getMarkupView(CustomizationContext customizationContext, MarkupDefinitionId markupDefinitionId) throws RemoteException
Getter for returning an immutable deep MarkupView. The MarkupView
object, unlike the MarkupDefinition
or the MarkupInstance
objects
contains a full set of references to all child pages, markups and so on. The
MarkupView
object, however is immutable.
markupDefinitionId
- the unique markupDefinitionId.
RemoteException
MarkupDefinition[] getMarkupDefinitions(CustomizationContext customizationContext, String webapp) throws RemoteException
Getter for returning a list of all MarkupDefinitions
scoped to the supplied webapp.
customizationContext
- for customization informationwebapp
- the web application these markup definitions are scoped to.
RemoteException
MarkupDefinition
MarkupDefinition getMarkupDefinition(CustomizationContext customizationContext, MarkupDefinitionId markupDefinitionId) throws RemoteException
Getter for returning a single MarkupDefinition
object given a supplied markup
definition identifier.
customizationContext
- for customization informationmarkupDefinitionId
- the unique markup definition identifier.
MarkupDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
- Throws
RemoteException
- See Also
MarkupDefinition
MarkupDefinition getMarkupDefinition(CustomizationContext customizationContext, String markupName, String webAppName) throws RemoteException
Getter for returning a single MarkupDefinition
object given a supplied markup
name.
customizationContext
- for customization informationmarkupName
- the markup name.
MarkupDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
- Throws
RemoteException
- See Also
MarkupDefinition
MarkupDefinition getMarkupDefinitionFromFile(CustomizationContext customizationContext, String markupFile, String webAppName) throws RemoteException
Getter for returning a single MarkupDefinition
object given a supplied markup file
name.
customizationContext
- for customization informationmarkupFile
- the name of the markup file relative to the webapp (/frameworks/markup/shell/my.shell)
MarkupDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
- Throws
RemoteException
- See Also
MarkupDefinition
MarkupDefinition createMarkupDefinition(CustomizationContext customizationContext, MarkupDefinition markupDefinition) throws MissingDataException, NotEntitledException, RemoteException, DuplicateObjectException
customizationContext
- for customization informationmarkupDefinition
- the markup data and associated placeholders
MissingDataException
- the markupDefinition supplied as an argument is missing some vital data.
NotEntitledException
- the caller is not entitled to create a new markup.
DuplicateObjectException
- another markup definition has the same markup name, type and webapp
RemoteException
void updateMarkupDefinition(CustomizationContext customizationContext, MarkupDefinition markupDefinition) throws ObjectNotFoundException, NotEntitledException, RemoteException
Update the markup definition with the new data.
customizationContext
- for customization informationmarkupDefinition
- the markup definition containing the new data
ObjectNotFoundException
- if the LocalizationIntersectionId in the LocalizationResource is bogus.
NotEntitledException
RemoteException
void deleteMarkupDefinition(CustomizationContext customizationContext, MarkupDefinitionId markupDefinitionId) throws ObjectNotFoundException, NotEntitledException, RemoteException
Delete a markup definition. The markup definition will not be deleted if it is a built-in type
or the markup is in use. This method will not throw an ObjectInUseException
instead
it will abort silently. To determine if these special conditions are occuring
turn on debugging for
com.bea.netuix.application.manager.persistence.jdbc.MarkupDefinitionDelegate
.
customizationContext
- for customization informationmarkupDefinitionId
- the id of the markup definition to delete.
ObjectNotFoundException
- if the markupDefinitionId is bogus
NotEntitledException
- the caller is not entitled to perform this operation.
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 |