public interface DispositionPhaseList extends java.lang.Iterable<DispositionPhase>
DispositionPhase
instances defined for a single DispositionSchedule
.Modifier and Type | Method and Description |
---|---|
int |
add(DispositionPhase phase)
Adds the specified
DispositionPhase instance to the
end of this collection. |
boolean |
contains(DispositionPhase phase)
Indicates whether or not the specified
DispositionPhase
instance is contained in this collection. |
DispositionPhase |
get(int position)
Returns the
DispositionPhase instance at the
given 1-based ordinal position. |
boolean |
isEmpty()
Indicates whether or not this collection is currently empty.
|
java.util.Iterator<DispositionPhase> |
iterator()
Returns an iterator over the contents of this collection.
|
void |
remove(DispositionPhase phase)
Removes the
DispositionPhase instance from this collection. |
void |
remove(int position)
Removes the
DispositionPhase instance at the specified
1-based ordinal position. |
void |
remove(java.lang.String phaseIdent)
Removes the
DispositionPhase instance specified
by its Id string. |
int |
size()
Returns the number of elements in this collection.
|
int add(DispositionPhase phase)
DispositionPhase
instance to the
end of this collection.
Persistence of changes to this collection will
not occur until the DispositionSchedule.save
method is called on the corresponding DispositionSchedule
.
phase
- the DispositionPhase
instance to add.
Cannot be null
.DispositionPhase
instance
within this collection.API_CANNOT_ADD_PHASE_ALREADY_EXISTS
- if the phase already exists in this collection.API_CANNOT_ADD_PHASE_ALREADY_IN_USE
- if the phase is already assigned to another schedule.API_CANNOT_ADD_PHASE_AFTER_TERMINATING_PHASE
- if an attempt is made to add a new phase to a schedule
that already contains a phase with an associated Destroy-
or Transfer-type disposition action.DispositionPhase get(int position)
DispositionPhase
instance at the
given 1-based ordinal position.position
- the 1-based ordinal position to retrieve from.DispositionPhase
instance.java.lang.IndexOutOfBoundsException
- if position is out-of-range.void remove(int position)
DispositionPhase
instance at the specified
1-based ordinal position.
The removed DispositionPhase
instance will be deleted
from the repository when the DispositionSchedule.save
method is called on the corresponding DispositionSchedule
.
position
- the 1-based ordinal position to remove from.java.lang.IndexOutOfBoundsException
- if position is out-of-range.API_CANNOT_REMOVE_PHASE_IT_IS_IN_USE
- if the DispositionPhase
instance is currently
in use by some Dispositionable
object.void remove(DispositionPhase phase)
DispositionPhase
instance from this collection.
The removed DispositionPhase
instance will be deleted
from the repository when the DispositionSchedule.save
method is called on the corresponding DispositionSchedule
.
phase
- the DispositionPhase
instance to remove from
this collection. Cannot be null
.API_PHASE_NOT_IN_COLLECTION
- if the specified DispositionPhase
instance
is not a member of this collection.API_CANNOT_REMOVE_PHASE_IT_IS_IN_USE
- if the DispositionPhase
instance is currently
in use by some Dispositionable
object.void remove(java.lang.String phaseIdent)
DispositionPhase
instance specified
by its Id string.
The removed DispositionPhase
instance will be deleted
from the repository when the DispositionSchedule.save
method is called on the corresponding DispositionSchedule
.
phaseIdent
- the String
phase identifier.
Cannot be null
nor blank.API_PHASE_NOT_IN_COLLECTION
- if the specified DispositionPhase
instance
is not a member of this collection.API_CANNOT_REMOVE_PHASE_IT_IS_IN_USE
- if the DispositionPhase
instance is currently
in use by some Dispositionable
object.int size()
boolean isEmpty()
true
if the collection is empty;
false
otherwise.boolean contains(DispositionPhase phase)
DispositionPhase
instance is contained in this collection.phase
- the DispositionPhase
instance to test for containment.
Cannot be null
.true
if the specified DispositionPhase
instance is a member; false
otherwise.java.util.Iterator<DispositionPhase> iterator()
iterator
in interface java.lang.Iterable<DispositionPhase>
Iterable.iterator()
© Copyright IBM Corp. 2010, 2013. All Rights Reserved.