|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ColumnService
Provides access and manipulation of column configuration for filters and default column configuration for users.
Method Summary | |
---|---|
ServiceOutcome<ColumnLayout> |
getColumnLayout(ApplicationUser serviceUser,
ApplicationUser userWithColumns)
Retreive the effective ColumnLayout for userWithColumns. |
ServiceOutcome<ColumnLayout> |
getColumnLayout(ApplicationUser serviceUser,
Long filterId)
Get the column layout for the given filter. |
ServiceOutcome<ColumnLayout> |
getDefaultColumnLayout(ApplicationUser serviceUser)
Get the system's default columns. |
ServiceResult |
resetColumns(ApplicationUser serviceUser,
ApplicationUser userWithColumns)
Resets a user's ColumnLayout . |
ServiceResult |
resetColumns(ApplicationUser serviceUser,
Long filterId)
Resets the given filter to no longer have its own ColumnLayout . |
ServiceResult |
setColumns(ApplicationUser serviceUser,
ApplicationUser userWithColumns,
List<String> fieldIds)
Sets a user's ColumnLayout . |
ServiceResult |
setColumns(ApplicationUser serviceUser,
Long filterId,
List<String> fieldIds)
Sets the given filter ColumnLayout to the given fields. |
ServiceResult |
setDefaultColumns(ApplicationUser serviceUser,
List<String> fieldIds)
Sets the system's default columns to the given fieldIds |
Method Detail |
---|
ServiceOutcome<ColumnLayout> getColumnLayout(ApplicationUser serviceUser, ApplicationUser userWithColumns)
ColumnLayout
for userWithColumns. Users may not have set their default columns in
which case they will be seeing the system's default columns. In that case the outcome contain the default
columns.
serviceUser
- for this service request.userWithColumns
- the user whose columns are being requested.
ColumnLayout
for the user.ServiceOutcome<ColumnLayout> getColumnLayout(ApplicationUser serviceUser, Long filterId)
serviceUser
- for this service request.filterId
- the id of the filter to get the column layout for.
ServiceOutcome<ColumnLayout> getDefaultColumnLayout(ApplicationUser serviceUser)
serviceUser
- for this service request. User must have admin access in order to perform this operation
ServiceResult setColumns(ApplicationUser serviceUser, ApplicationUser userWithColumns, List<String> fieldIds)
ColumnLayout
.
serviceUser
- for this service request.userWithColumns
- the use whose columns are being set.fieldIds
- the list of field ids to set as the user's ColumnLayout.
ServiceResult setColumns(ApplicationUser serviceUser, Long filterId, List<String> fieldIds)
ColumnLayout
to the given fields.
serviceUser
- for this service requestfilterId
- id of the filterfieldIds
- the list of field ids to set as the filter's ColumnLayout
ServiceResult setDefaultColumns(ApplicationUser serviceUser, List<String> fieldIds)
fieldIds
serviceUser
- for this service request. User must have admin access in order to perform this operationfieldIds
- the list of field ids to set as the system's default ColumnLayout
ServiceResult resetColumns(ApplicationUser serviceUser, ApplicationUser userWithColumns)
ColumnLayout
.
serviceUser
- for this service request.userWithColumns
- the use whose columns are being reset.
ServiceResult resetColumns(ApplicationUser serviceUser, Long filterId)
ColumnLayout
.
serviceUser
- for this service requestfilterId
- id of the filter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |