Overview | Package | Class | Tree | Deprecated | Index | Help
| Copyright © 2008 BEA Systems, Inc. All Rights Reserved
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bea.portal.tools.portal.controls
Interface LookAndFeelDefinitionControl

    @ControlInterface
    public interface LookAndFeelDefinitionControl

A custom control interface used to interact with LookAndFeelDefinitions.

Method Summary
`void` | `deleteLookAndFeelDefinition(LookAndFeelDefinitionId id, ResourceContext context)` Deletes a specified `LookAndFeelDefinition`.
`void` | `deleteThemeDefinition(ThemeDefinitionId id, boolean cascadeDelete, ResourceContext context)` Delete a `ThemeDefinition` if it is not currently in use.
`LookAndFeelDefinition` | `getLookAndFeelDefinition(LookAndFeelDefinitionId id, ResourceContext context)` Used to retieve a single `LookAndFeelDefinition` object given an Id.
`LookAndFeelDefinitionId` | `getLookAndFeelDefinitionId(String markupName, String webAppName, ResourceContext context)` Getter for returning a single `LookAndFeelDefinitionId` object given a supplied lookAndFeel markup name and webapp.
`SortableFilterablePagedResult<LookAndFeelDefinition>` | `getLookAndFeelDefinitions(int pageSize, WebAppSearchCriteria criteria, ResourceContext context)` This methods gets all `LookAndFeelDefinitions` scoped to the specified webapp
`ThemeDefinition` | `getThemeDefinition(ThemeDefinitionId id, ResourceContext context)` Getter for returning a single `ThemeDefinition` object given a supplied theme definition identifier.
`SortableFilterablePagedResult<ThemeDefinition>` | `getThemeDefinitions(int pageSize, WebAppSearchCriteria criteria, ResourceContext context)` Return a `PagedResult` of `ThemeDefinition`s matching the specified criteria.

Method Detail

### getThemeDefinitions

    SortableFilterablePagedResult<ThemeDefinition> getThemeDefinitions(int pageSize,
                                                                       WebAppSearchCriteria criteria,
                                                                       ResourceContext context)
                                                                       throws ToolsException

  Return a `PagedResult` of `ThemeDefinition`s matching the specified criteria.

  Parameters
    `pageSize` - The number of results to retrieve per page
    `criteria` - The web application to search
    `context` - The resource context
  Returns
    a paginated result of theme definitions
  Throws
    `ToolsException`

### getThemeDefinition

    ThemeDefinition getThemeDefinition(ThemeDefinitionId id,
                                       ResourceContext context)
                                       throws ToolsException

  Getter for returning a single `ThemeDefinition` object given a supplied theme definition identifier.

  Parameters
    `id` - the ID of the theme definition to retrieve
    `context` - the resource context
  Returns
    the requested theme definition or null if none exists.
  Throws
    `ToolsException`

### deleteThemeDefinition

    void deleteThemeDefinition(ThemeDefinitionId id,
                               boolean cascadeDelete,
                               ResourceContext context)
                               throws ObjectInUseException,
                                      ToolsException,
                                      NotEntitledException,
                                      ObjectNotFoundException

  Delete a `ThemeDefinition` if it is not currently in use.

  Parameters
    `id` - the ID of the theme definition to delete
    `cascadeDelete` - `true` if all associated objects should be deleted.
    `context` - the resource context
  Throws
    `ObjectInUseException`
    `ToolsException`
    `NotEntitledException`
    `ObjectNotFoundException`

### getLookAndFeelDefinitions

    SortableFilterablePagedResult<LookAndFeelDefinition> getLookAndFeelDefinitions(int pageSize,
                                                                                   WebAppSearchCriteria criteria,
                                                                                   ResourceContext context)
                                                                                   throws ToolsException

  This methods gets all `LookAndFeelDefinitions` scoped to the specified webapp

  Parameters
    `pageSize` - The size of one page in the `PagedResult`
    `criteria` - The criteria (such as web application name) to use in the search.
    `context` - the resource context.
  Returns
    A `PagedResult` containg iterators of `LookAndFeelDefinitions` matching the specified criteria.
  Throws
    `ToolsException`

### getLookAndFeelDefinition

    LookAndFeelDefinition getLookAndFeelDefinition(LookAndFeelDefinitionId id,
                                                   ResourceContext context)
                                                   throws ToolsException

  Used to retieve a single `LookAndFeelDefinition` object given an Id.

  Parameters
    `id` - the ID of the look and feel to retreive
    `context` - the resource context.
  Returns
    A `LookAndFeelDefinition` object for the specified ID
  Throws
    `ToolsException`

### deleteLookAndFeelDefinition

    void deleteLookAndFeelDefinition(LookAndFeelDefinitionId id,
                                     ResourceContext context)
                                     throws ObjectInUseException,
                                            ToolsException,
                                            NotEntitledException,
                                            ObjectNotFoundException

  Deletes a specified `LookAndFeelDefinition`.

  Parameters
    `id` - The id of the look and feel to delete
    `context` - the resource context.
  Throws
    `ObjectInUseException`
    `ToolsException`
    `NotEntitledException`
    `ObjectNotFoundException`

### getLookAndFeelDefinitionId

    LookAndFeelDefinitionId getLookAndFeelDefinitionId(String markupName,
                                                       String webAppName,
                                                       ResourceContext context)
                                                       throws ToolsException

  Getter for returning a single `LookAndFeelDefinitionId` object given a supplied lookAndFeel markup name and webapp.

  Parameters
    `markupName` - the markup name attribute supplied on the tag in the .laf file
    `webAppName` - the webapp name
    `context` - the resource context.
  Returns
    the unique lookAndFeel definition identifier or null if non existent.
  Throws
    `ToolsException`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 BEA Systems, Inc. All Rights Reserved