|
Oracle® Information Rights Management Server Java API Reference 11g Release 1 (11.1.1) E12907-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LabelOperations
Operations on labels. Provides utilities for working with labels and collections of labels.
The methods on LabelOperations can be invoked using LabelOperationsInstance
.
Method Summary | |
---|---|
Collection<Label> |
copyLabels(Collection<Label> labels, int length) Copy a set of labels. |
Label |
getLabel(Collection<Label> labels, Locale[] locales) Get a label from a collection. |
Label |
getUnknownLabel(Locale locale) Get the unknown label. |
Collection<Label> |
sortLabels(Collection<Label> labels, Locale[] locales) Sort labels into a locale preference order. |
void |
validateLabel(Label label, int name, int description) Validate the name and description lengths of a label. |
void |
validateLabels(Collection<Label> labels, int name, int description) Validate the name and description lengths of a set of label values. |
Method Detail |
---|
Label getLabel(Collection<Label> labels, Locale[] locales)
labels
- the set of labels. This parameter is optional, it is valid to pass null or an empty collection.locales
- locales. The labels are searched in the same order as the provided array.Label getUnknownLabel(Locale locale)
locale
- locale. The locale required.Collection<Label> copyLabels(Collection<Label> labels, int length)
Name
property is also changed to reflect the label has been copied. For example, in English, the label Top Secret would turn into Copy Of Top Secret. If the new label name exceeds the maximum length provided the copied name is truncated.labels
- the set of labels to copy. This parameter is optional, it is valid to pass null or an empty collection.length
- maximum label name size. Set the size to 0 if there is no limit of the length of the name.Collection<Label> sortLabels(Collection<Label> labels, Locale[] locales)
labels
- the set of labels to sort. This parameter is optional, it is valid to pass null or an empty collection.locales
- the locale(s) sort order. If no locales are specified, the default locale is used as the only sort criteria. This parameter is optional, it is valid to pass null.void validateLabels(Collection<Label> labels, int name, int description) throws IllegalArgumentException
labels
- labels to validate. This parameter is optional, it is valid to pass null or an empty collection.name
- maximum name size.description
- maximum description size. Ignored if a label does not have a maximum size.IllegalArgumentException
- if either the name or description have invalid lengths.void validateLabel(Label label, int name, int description) throws IllegalArgumentException
label
- label to validate.name
- maximum name size.description
- maximum description size. Ignored if a label does not have a description.IllegalArgumentException
- if either the name or description have invalid lengths.
|
Oracle® Information Rights Management Server Java API Reference 11g Release 1 (11.1.1) E12907-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |