Class AssigneeContainer
Wraps a collection of Assignees associated with a JobActivity.
Inheritance
Inherited Members
Namespace: Moraware.JobTrackerAPI5
Assembly: JobTrackerAPI5.dll
Syntax
public class AssigneeContainer : IEnumerable<Assignee>, IEnumerable
Methods
AddAssignee(Int32)
Adds the given assignee.
Declaration
public Assignee AddAssignee(int assigneeId_)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | assigneeId_ | Identifies the assignee to add. |
Returns
| Type | Description |
|---|---|
| Assignee | The newly added assignee. |
ContainsItemWithId(Int32)
Checks if an item with the given Id has already been added.
Declaration
public bool ContainsItemWithId(int id_)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | id_ | Id to check for. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if there is an item for the given id_. |
Count()
Number of items.
Declaration
public int Count()
Returns
| Type | Description |
|---|---|
| System.Int32 | Number of item's in the collection. |
GetEnumerator()
Provides an iterator over the collection members.
Declaration
public IEnumerator<Assignee> GetEnumerator()
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerator<Assignee> | An iterator over the collection members. |
Remarks
This method is present primarily to support the For ... Each syntax.
Item(Int32)
Looks up the item with the given id.
Declaration
public Assignee Item(int id_)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | id_ | Id of the item to search for. |
Returns
| Type | Description |
|---|---|
| Assignee | The item with the given id. |
Item(String, Boolean)
Looks up the item with the given name.
Declaration
public Assignee Item(string name_, bool exceptionIfNotThere_ = false)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name_ | Name of Assignee to search for. |
| System.Boolean | exceptionIfNotThere_ | If True and no such Assignee name is found, an exception will be thrown. |
Returns
| Type | Description |
|---|---|
| Assignee | The Assignee with the given name. |
ItemAt(Int32)
Returns the item at the given index.
Declaration
public Assignee ItemAt(int zeroBasedIndex_)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | zeroBasedIndex_ | Index to retrieve. |
Returns
| Type | Description |
|---|---|
| Assignee | The indicated item. |
Explicit Interface Implementations
IEnumerable.GetEnumerator()
Provides a strongly typed iterator over the collection members.
Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerator | A strongly typed iterator over the collection members. |
Remarks
This method is present primarily to support the For ... Each syntax.