|
Query |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BusinessGroup
The purpose of this object to allow the ability to group certain IQ objects outside of our normal MapFolder
structure.
The BusinessGroup.Type
value of Group is used to hint at the usage of the Group or have a defined internal meaning for a BusinessQuery
.
Nested Class Summary | |
---|---|
static class |
BusinessGroup.Type
Usage of the Group or have a defined internal meaning for a BusinessQuery |
Field Summary | |
---|---|
static java.lang.String |
EVENT_BUSINESS_GROUP_ITEMS_CHANGED
Indication that the data item's aggregation type that are supported are changed. |
static java.lang.String |
EVENT_BUSINESS_GROUP_NOTES_CHANGED
Indication that the group's note value has changed. |
Fields inherited from interface com.sas.iquery.metadata.business.ModelItemWithIdentity |
---|
EVENT_DESCRIPTION_CHANGED, EVENT_HIDDEN_CHANGED, EVENT_ID_CHANGED, EVENT_LABEL_CHANGED |
Fields inherited from interface com.sas.iquery.metadata.business.ModelItem |
---|
EVENT_OBJECT_PROPERTY_CHANGED |
Fields inherited from interface com.sas.iquery.metadata.business.Base |
---|
EVENT_OBJECT_DEFINITION_CHANGED |
Fields inherited from interface com.sas.iquery.metadata.business.LocalizableModelObject |
---|
EVENT_LOCALIZABLE_DESCRIPTIONS_CHANGED, EVENT_LOCALIZABLE_LABELS_CHANGED |
Method Summary | |
---|---|
void |
clear()
Removes all of the items from this group. |
boolean |
contains(BusinessModelObject businessModelObject)
Returns an indication of whether the given business model object is contained within this group. |
boolean |
contains(BusinessModelObject businessModelObject,
boolean recursive)
Returns an indication of whether the given business model object is contained within this group or subgroups. |
java.util.List<BusinessGroup> |
getContainedGroups()
Returns all the contained group objects within this group. |
java.util.List<BusinessModelObject> |
getItems()
Returns an java.util.List containing all of the items in this group in the
order they were added. |
java.lang.String |
getNote()
Returns the notes string for this group |
BusinessGroup.Type |
getType()
Returns the BusinessGroup.Type of this group |
void |
setItems(java.util.List<? extends BusinessModelObject> items)
Sets the java.util.List of BusinessModelObject to be grouped. |
void |
setNote(java.lang.String note)
Sets the user notes for this group |
int |
size()
Returns the number of items in this group. |
Methods inherited from interface com.sas.iquery.metadata.business.BusinessModelObject |
---|
getBusinessModel, isContainedInBusinessModel, isIDOK, isReadOnly |
Methods inherited from interface com.sas.iquery.metadata.business.ModelItemWithIdentity |
---|
getID, getIdentityString, getIntraModelID, isHidden, isUnresolved, setDescription, setIntraModelID, setIsHidden, setLabel |
Methods inherited from interface com.sas.iquery.metadata.PropertyChangeListenee |
---|
addListener, getListeners, removeListener |
Methods inherited from interface com.sas.iquery.metadata.business.UsabilityInterface |
---|
getReasonsUnusable, isUsableInQuery |
Methods inherited from interface com.sas.iquery.metadata.business.BusinessModelResource |
---|
isUnresolved |
Methods inherited from interface com.sas.iquery.metadata.business.BusinessModelResourceReferencer |
---|
getResources |
Methods inherited from interface com.sas.iquery.metadata.business.ExtendedAttributes |
---|
getExtendedAttributes, setExtendedAttributes |
Methods inherited from interface com.sas.iquery.metadata.business.LocalizableModelObject |
---|
getLocalizableProperties, getLocalizationPrependKey, setDescription, setDescriptions, setLabel, setLabels, setLocalizableProperties |
Methods inherited from interface com.sas.iquery.metadata.LocalizableNamedObjectInterface |
---|
getDescription, getDescriptions, getLabel, getLabels |
Methods inherited from interface com.sas.iquery.metadata.NamedObjectInterface |
---|
getDescription, getLabel |
Field Detail |
---|
static final java.lang.String EVENT_BUSINESS_GROUP_NOTES_CHANGED
static final java.lang.String EVENT_BUSINESS_GROUP_ITEMS_CHANGED
Method Detail |
---|
BusinessGroup.Type getType()
BusinessGroup.Type
of this group
Type
of this group.@Nonnull java.util.List<BusinessModelObject> getItems()
java.util.List
containing all of the items in this group in the
order they were added. If the group contains no items an empty list is returned.
void setItems(@Nonnull java.util.List<? extends BusinessModelObject> items)
java.util.List
of BusinessModelObject
to be grouped.
The specified list will be copied into an internal ArrayList object.
java.lang.String getNote()
void setNote(java.lang.String note)
note
- String.boolean contains(BusinessModelObject businessModelObject)
businessModelObject
- the object to search for.
boolean contains(BusinessModelObject businessModelObject, boolean recursive)
businessModelObject
- the object to search for.recursive
- if true all subgroups are included in the search.
@Nonnull java.util.List<BusinessGroup> getContainedGroups()
BusinessGroup
objects or an empty listvoid clear()
int size()
|
Query |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |