Class JobPhaseContainer

Wraps a collection of job phases and includes an 'All' flag that can be set to indicate that the Entire Job is covered.

Inheritance

System.Object

JobPhaseContainer

Implements

System.Collections.Generic.IEnumerable<JobPhase>

System.Collections.IEnumerable

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Moraware.JobTrackerAPI5

Assembly: JobTrackerAPI5.dll

Syntax

public class JobPhaseContainer : IEnumerable<JobPhase>, IEnumerable

Properties

All

Indicates whether the Entire Job is covered.

Declaration

public bool All { get; set; }

Property Value

Type	Description
System.Boolean	Setting this to True will clear any specific JobPhases that may have already been added.

Methods

Add(JobPhase)

Adds the given job phase to the attached object.

Declaration

public void Add(JobPhase jobPhase_)

Parameters

Type	Name	Description
JobPhase	jobPhase_	Job phase to add.2

Remarks

By adding a JobPhase , the All property is automatically set to False.

Clear()

Removes any JobPhases. (The All property will also be cleared if it's currently set.)

Declaration

public void Clear()

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<JobPhase> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<JobPhase>	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 JobPhase Item(int id_)

Parameters

Type	Name	Description
System.Int32	id_	Id of the item to search for.

Returns

Type	Description
JobPhase	The item with the given id.

Item(String, Boolean)

Looks up the item with the given name.

Declaration

public JobPhase Item(string name_, bool exceptionIfNotThere_ = false)

Parameters

Type	Name	Description
System.String	name_	Name of JobPhase to search for.
System.Boolean	exceptionIfNotThere_	If True and no such JobPhase name is found, an exception will be thrown.

Returns

Type	Description
JobPhase	The JobPhase with the given name.

ItemAt(Int32)

Returns the item at the given index.

Declaration

public JobPhase ItemAt(int zeroBasedIndex_)

Parameters

Type	Name	Description
System.Int32	zeroBasedIndex_	Index to retrieve.

Returns

Type	Description
JobPhase	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.

Implements

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable