Class NSArchiveRestrictionGroup
Carrier for restriction group. Contains all the search restrictions for the group - that is, ArchiveRestrictionInfo - objects, including info such as rank and name.
Syntax
Constructors
NSArchiveRestrictionGroup()
Initializes a new instance of the NSArchiveRestrictionGroup class.
Declaration
NSArchiveRestrictionGroup
Methods
GetDescription()
Carrier for restriction group. Contains all the search restrictions for the group - that is, ArchiveRestrictionInfo - objects, including info such as rank and name.
Declaration
String GetDescription()
Returns
Type | Description |
---|---|
String | Description of group. |
Examples
NSArchiveRestrictionGroup thing;
String description = thing.GetDescription();
GetName()
Carrier for restriction group. Contains all the search restrictions for the group - that is, ArchiveRestrictionInfo - objects, including info such as rank and name.
Declaration
String GetName()
Returns
Type | Description |
---|---|
String | The name of this criteria group. |
Examples
NSArchiveRestrictionGroup thing;
String name = thing.GetName();
GetRank()
Carrier for restriction group. Contains all the search restrictions for the group - that is, ArchiveRestrictionInfo - objects, including info such as rank and name.
Declaration
Integer GetRank()
Returns
Type | Description |
---|---|
Integer | Rank order within this CriteriaModel. |
Examples
NSArchiveRestrictionGroup thing;
Integer rank = thing.GetRank();
GetRestrictions()
Carrier for restriction group. Contains all the search restrictions for the group - that is, ArchiveRestrictionInfo - objects, including info such as rank and name.
Declaration
NSArchiveRestrictionInfo[] GetRestrictions()
Returns
Type | Description |
---|---|
NSArchiveRestrictionInfo[] | Array of NSArchiveRestrictionInfo restriction specifications. |
Examples
NSArchiveRestrictionGroup thing;
NSArchiveRestrictionInfo[] restrictions = thing.GetRestrictions();
SetDescription(String)
Carrier for restriction group. Contains all the search restrictions for the group - that is, ArchiveRestrictionInfo - objects, including info such as rank and name.
Declaration
Void SetDescription(String description)
Parameters
Type | Name | Description |
---|---|---|
String | description | Description of group. |
Returns
Type | Description |
---|---|
Void |
Examples
NSArchiveRestrictionGroup thing;
String description;
thing.SetDescription(description);
SetName(String)
Carrier for restriction group. Contains all the search restrictions for the group - that is, ArchiveRestrictionInfo - objects, including info such as rank and name.
Declaration
Void SetName(String name)
Parameters
Type | Name | Description |
---|---|---|
String | name | The name of this criteria group. |
Returns
Type | Description |
---|---|
Void |
Examples
NSArchiveRestrictionGroup thing;
String name;
thing.SetName(name);
SetRank(Integer)
Carrier for restriction group. Contains all the search restrictions for the group - that is, ArchiveRestrictionInfo - objects, including info such as rank and name.
Declaration
Void SetRank(Integer rank)
Parameters
Type | Name | Description |
---|---|---|
Integer | rank | Rank order within this CriteriaModel. |
Returns
Type | Description |
---|---|
Void |
Examples
NSArchiveRestrictionGroup thing;
Integer rank;
thing.SetRank(rank);
SetRestrictions(NSArchiveRestrictionInfo[])
Carrier for restriction group. Contains all the search restrictions for the group - that is, ArchiveRestrictionInfo - objects, including info such as rank and name.
Declaration
Void SetRestrictions(NSArchiveRestrictionInfo[] restrictions)
Parameters
Type | Name | Description |
---|---|---|
NSArchiveRestrictionInfo[] | restrictions | Array of NSArchiveRestrictionInfo restriction specifications. |
Returns
Type | Description |
---|---|
Void |
Examples
NSArchiveRestrictionGroup thing;
NSArchiveRestrictionInfo[] restrictions;
thing.SetRestrictions(restrictions);