|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ControlInterface public interface DesktopDefinitionControl
A custom control interface used to interact with DesktopDefinitions.
Method Summary | |
---|---|
DesktopDefinition |
createDesktopDefinition(String desktopName,
String desktopDescription,
ShellDefinitionId shellId,
LookAndFeelDefinitionId lafId,
BookDefinitionId bookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Creates a new desktop defintion. |
DesktopDefinition |
createDesktopFromPortalFile(String portalTemplatePath,
String desktopTitle,
String desktopDescription,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
int disassemblerAction,
ResourceContext context)
Creates a desktop from a portal file |
DesktopDefinition |
createDesktopFromTemplate(TemplateId id,
PortalPath portalPath,
DesktopPath desktopPath,
String title,
String description,
ResourceContext context)
Creates a desktop from the specified template |
DesktopDefinition |
createDesktopTemplate(String desktopName,
String desktopDescription,
ShellDefinitionId shellId,
LookAndFeelDefinitionId lafId,
BookDefinitionId bookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
boolean global,
ResourceContext context)
Creates a new desktop template. |
DesktopDefinition |
createDesktopTemplateFromPortalFile(String portalTemplatePath,
String desktopTitle,
String desktopDescription,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
int disassemblerAction,
boolean global,
ResourceContext context)
Creates a desktop template from a portal file |
void |
deleteDesktopDefinition(String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
boolean cascadeDelete,
ResourceContext context)
Deletes a desktop definition object |
DesktopDefinition |
getDesktopDefinition(DesktopDefinitionId desktopDefId,
ResourceContext context)
Gets the DesktopDefinition for the specified ID. |
DesktopDefinition |
getDesktopDefinition(String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Gets a mutable DesktopDefinition object. |
SortableFilterablePagedResult<DesktopDefinition> |
getDesktopDefinitions(int pageSize,
DesktopSearchCriteria criteria,
ResourceContext context)
Gets all the desktop defintions scoped to the specified webapp and portal. |
DesktopView |
getDesktopView(String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Gets a desktop view scoped to the web app. |
DesktopView |
getDesktopViewFromPortalFile(String webApp,
String path,
ResourceContext context)
Gets a desktop view from a portal file. |
void |
updateAsyncMode(DesktopDefinition.AsyncModeType modeType,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Updates the async content for the desktop |
void |
updateDesktopDefinition(DesktopDefinition desktopDef,
ResourceContext context)
Update a desktop definition. |
void |
updateDisc(boolean opt,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Updates the disc attribute for the desktop |
void |
updateDvt(boolean opt,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Updates the dvt attribute for the desktop |
void |
updateLookAndFeelInDesktopDefinition(LookAndFeelDefinitionId lafId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Updates the the look and feel for a desktop definiton. |
void |
updatePrimaryBookInDesktopDefinition(BookDefinitionId bookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Updates the primary book definition associated with a desktop. |
void |
updateScrollToWindow(boolean opt,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Updates the scrollToWindow attribute for the desktop |
void |
updateShellInDesktopDefinition(ShellDefinitionId shellId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Update the shell for the desktop. |
void |
updateTreeOptimization(boolean opt,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Updates the tree optimization attribute for the desktop |
Method Detail |
---|
DesktopView getDesktopView(String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException
webApp
- the web application nameportalPath
- The path to the portal containg this desktop.desktopPath
- The path to the desktopcontext
- the resource context
ToolsException
DesktopDefinition getDesktopDefinition(String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException
webApp
- the web application nameportalPath
- The path to portal.desktopPath
- The path of the desktop.context
- the resource context
ToolsException
DesktopDefinition getDesktopDefinition(DesktopDefinitionId desktopDefId, ResourceContext context) throws ToolsException
desktopDefId
- the definition id for the desktopcontext
- a resource context
ToolsException
SortableFilterablePagedResult<DesktopDefinition> getDesktopDefinitions(int pageSize, DesktopSearchCriteria criteria, ResourceContext context) throws ToolsException
pageSize
- The pagesize of the returned PagedResult.criteria
- the criteria for the search, including webapp and portal pathcontext
- the resource context
ToolsException
void updateTreeOptimization(boolean opt, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
opt
- true enables optimizations.webApp
- the web application nameportalPath
- The portal path containing the desktop.desktopPath
- The desktop path to delete.context
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
void updateScrollToWindow(boolean opt, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
opt
- true enables scrollToWindow.webApp
- the web application nameportalPath
- The portal path containing the desktop.desktopPath
- The desktop path to delete.context
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
void updateAsyncMode(DesktopDefinition.AsyncModeType modeType, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
modeType
- valid values from the enumeration are compatibility, enabled, and disabled. Please see
DesktopDefinition.AsyncModeType
for more information on valid values.webApp
- the web application nameportalPath
- The portal path containing the desktop.desktopPath
- The desktop path to delete.context
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
void updateDisc(boolean opt, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
opt
- true enables disc.webApp
- the web application nameportalPath
- The portal path containing the desktop.desktopPath
- The desktop path to delete.context
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
void updateDvt(boolean opt, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
opt
- true enables dvt.webApp
- the web application nameportalPath
- The portal path containing the desktop.desktopPath
- The desktop path to delete.context
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
void deleteDesktopDefinition(String webApp, PortalPath portalPath, DesktopPath desktopPath, boolean cascadeDelete, ResourceContext context) throws ToolsException, ObjectInUseException, NotEntitledException, ObjectNotFoundException
webApp
- the web application nameportalPath
- The portal path containing the desktop.desktopPath
- The desktop path to delete.cascadeDelete
- True to perform a cascade delete.context
- the resource context
ToolsException
ObjectInUseException
NotEntitledException
ObjectNotFoundException
void updateShellInDesktopDefinition(ShellDefinitionId shellId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
shellId
- The id of the shell definition.webApp
- the web application nameportalPath
- The portal path containing the desktop.desktopPath
- The desktop path to delete.context
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
void updateLookAndFeelInDesktopDefinition(LookAndFeelDefinitionId lafId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
lafId
- The look and feel id for the desktop.webApp
- the web application nameportalPath
- The portal path containing the desktop.desktopPath
- The desktop path to delete.context
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
void updatePrimaryBookInDesktopDefinition(BookDefinitionId bookId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
bookId
- The book definition id.webApp
- the web application nameportalPath
- The portal path containing the desktop.desktopPath
- The desktop path to delete.context
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
void updateDesktopDefinition(DesktopDefinition desktopDef, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
desktopDef
- The desktop definition to update.context
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
DesktopDefinition createDesktopDefinition(String desktopName, String desktopDescription, ShellDefinitionId shellId, LookAndFeelDefinitionId lafId, BookDefinitionId bookId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, DuplicateObjectException, NotEntitledException, MissingDataException, ObjectNotFoundException
desktopName
- The desktop name.desktopDescription
- The description of the desktop.shellId
- The id of the shell definition.lafId
- The id of the look and feel.bookId
- The id of the primary book.webApp
- The webapp scope.portalPath
- The portal path containing the desktop.desktopPath
- The desktop path to delete.context
- the resource context
ToolsException
DuplicateObjectException
NotEntitledException
MissingDataException
ObjectNotFoundException
DesktopDefinition createDesktopTemplate(String desktopName, String desktopDescription, ShellDefinitionId shellId, LookAndFeelDefinitionId lafId, BookDefinitionId bookId, String webApp, PortalPath portalPath, DesktopPath desktopPath, boolean global, ResourceContext context) throws ToolsException, DuplicateObjectException, NotEntitledException, MissingDataException, ObjectNotFoundException
desktopName
- The desktop name.desktopDescription
- The description of the desktop.shellId
- The id of the shell definition.lafId
- The id of the look and feel.bookId
- The id of the primary book.webApp
- The webapp scope.portalPath
- The portal path containing the desktop.desktopPath
- The desktop path to delete.global
- does this template appear in the librarycontext
- the resource context
ToolsException
DuplicateObjectException
NotEntitledException
MissingDataException
ObjectNotFoundException
DesktopDefinition createDesktopFromTemplate(TemplateId id, PortalPath portalPath, DesktopPath desktopPath, String title, String description, ResourceContext context) throws ToolsException, DuplicateObjectException, NotEntitledException, MissingDataException, ObjectNotFoundException
id
- the ID of the template to create the desktop from.portalPath
- the portal path for the new desktopdesktopPath
- the desktop path for the new desktoptitle
- the title of the new desktopdescription
- the description of the new desktopcontext
- the resource context
DuplicateObjectException
NotEntitledException
MissingDataException
ObjectNotFoundException
ToolsException
DesktopView getDesktopViewFromPortalFile(String webApp, String path, ResourceContext context) throws IOException, XmlDisassemblerException, FileNotFoundException, ToolsException
webApp
- the portal file resides in.path
- the portal file.context
- the resource context
IOException
XmlDisassemblerException
FileNotFoundException
ToolsException
DesktopDefinition createDesktopFromPortalFile(String portalTemplatePath, String desktopTitle, String desktopDescription, String webApp, PortalPath portalPath, DesktopPath desktopPath, int disassemblerAction, ResourceContext context) throws IOException, ToolsException, DuplicateObjectException, DuplicateDefinitionException, NotEntitledException, MissingDataException, ObjectNotFoundException, XmlDisassemblerException, ViewDisassemblerException
portalTemplatePath
- fully qualified name relative to the webapp of portal
file to create a desktop fromdesktopTitle
- the title of the new desktopdesktopDescription
- the description of the new desktopwebApp
- the web application nameportalPath
- the portal path for the new desktopdesktopPath
- the desktop path for the new desktopdisassemblerAction
- Possible actions are: context
- the resource context
IOException
DuplicateObjectException
DuplicateDefinitionException
NotEntitledException
MissingDataException
ObjectNotFoundException
XmlDisassemblerException
ViewDisassemblerException
ToolsException
DesktopDefinition createDesktopTemplateFromPortalFile(String portalTemplatePath, String desktopTitle, String desktopDescription, String webApp, PortalPath portalPath, DesktopPath desktopPath, int disassemblerAction, boolean global, ResourceContext context) throws IOException, ToolsException, DuplicateObjectException, DuplicateDefinitionException, NotEntitledException, MissingDataException, ObjectNotFoundException, XmlDisassemblerException, ViewDisassemblerException
portalTemplatePath
- fully qualified name relative to the webapp of portal
file to create a desktop template fromdesktopTitle
- the title of the new desktopdesktopDescription
- the description of the new desktopwebApp
- the web application nameportalPath
- the portal path for the new desktopdesktopPath
- the desktop path for the new desktopdisassemblerAction
- Possible actions are: global
- does this template reside in the librarycontext
- the resource context
IOException
DuplicateObjectException
DuplicateDefinitionException
NotEntitledException
MissingDataException
ObjectNotFoundException
XmlDisassemblerException
ViewDisassemblerException
ToolsException
|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |