public class AuditSearchGenerator extends Object
Constructor and Description |
---|
AuditSearchGenerator(AuditSpecification spec,
long[] targetIds,
String searchClause,
String sortClause)
Creates an AuditSearchGenerator from BL code.
|
AuditSearchGenerator(LibrarySession session,
Map searchOptions,
AttributeValue[] sortOptions)
Creates an AuditSearchGenerator.
|
Modifier and Type | Method and Description |
---|---|
void |
checkAuthorization()
Checks if the current user is authorized to perform the search.
|
String |
createSearchClause()
Returns the search clause to use for the audit search.
|
String |
createSearchClause(boolean domainScoped)
Returns the search clause to use for the audit search.
|
String |
createSortClause()
Returns the sort clause to use for the audit search.
|
String |
deriveSearchClause()
Derives the search clause to use for the audit search.
|
String |
deriveSearchClause(boolean domainScoped)
Derives the search clause to use for the audit search.
|
Long |
getAuditSpecificationId()
Returns the AuditSpecification ID to use for the audit search.
|
int |
getResultLimit()
Returns the limit of the number of items to return for the audit search.
|
public AuditSearchGenerator(LibrarySession session, Map searchOptions, AttributeValue[] sortOptions) throws IfsException
session
- session contextsearchOptions
- a Map of raw search optionssortOptions
- a Map of raw sort optionsIfsException
- if the operation failspublic AuditSearchGenerator(AuditSpecification spec, long[] targetIds, String searchClause, String sortClause) throws IfsException
spec
- the AuditSpecification to searchtargetIds
- the target IDs, if anysearchClause
- the search clausesortClause
- the sort clauseIfsException
- if the operation failspublic Long getAuditSpecificationId()
public int getResultLimit()
public String createSearchClause() throws IfsException
IfsException
- if the operation fails.ClassCastException
- if any of the sort options have values
that are invalid datatypespublic String createSearchClause(boolean domainScoped) throws IfsException
domainScoped
- indicates whether Domain ID clause
should be includedIfsException
- if the operation fails.ClassCastException
- if any of the sort options have values
that are invalid datatypespublic String deriveSearchClause() throws IfsException
IfsException
- if the operation failsClassCastException
- if any of the sort options have values
that are invalid datatypespublic String deriveSearchClause(boolean domainScoped) throws IfsException
domainScoped
- indicates whether Domain ID clause
should be includedIfsException
- if the operation failsClassCastException
- if any of the sort options have values
that are invalid datatypespublic String createSortClause() throws IfsException
IfsException
- if the operation fails.public void checkAuthorization() throws IfsException
IfsException
- if the user does not have access, or if the
operation otherwise failsCopyright © 2023. All rights reserved.