StyleRepositoryService

Name StyleRepository
Version
Included Services  
Java Package org.kuali.rice.coreservice.api.style

Service for interacting with {@link Style} data. This service primarily
consists of pure data-access operations on a repository of styles which are
accessible based on their name or id which are both unique.

Operations
Main Message Structures

Method getStyle
Description Returns the style with the given name. If no style with the given name
can be found, this method will return null.
Parameters String styleName the name of the style to retrieve, must not be null or
blank
Return Style the style with the given name, or null if no style with the given
name could be found
Errors RiceIllegalArgumentException if the given styleName is null or blank

Back to Operations

Method saveStyle
Description Creates or updates the Style represented by the given record. If the
id on the style is not null, then it will update the existing
style record which has that id. Otherwise it will create a new style in
the repository.

When updating an existing style, the caller needs to ensure that the
id, versionNumber, and objectId values are set on the given Style
object.
Parameters Style style the style data to create or update in the repository
Return void the style with the given name, or null if no style with the given
name could be found
Errors RiceIllegalArgumentException if the given style is null

Back to Operations

Method getAllStyleNames
Description Returns a list of the names for all active styles in the repository. If
there are no active styles, this list will be empty. It will never
return null.
Parameters None None No Parameters
Return StringList the list of names for all active styles
Errors NONE No Errors

Back to Operations