public interface AlternateRetentionList extends java.lang.Iterable<AlternateRetention>
AlternateRetention
instances defined for a single DispositionPhase
.Modifier and Type | Method and Description |
---|---|
int |
add(AlternateRetention altRetent)
Adds the given
AlternateRetention instance to the
end of this collection. |
boolean |
contains(AlternateRetention altRetent)
Indicates whether or not the specified
AlternateRetention
instance is contained in this collection. |
AlternateRetention |
get(int position)
Returns the
AlternateRetention instance at the
given 1-based ordinal position. |
boolean |
isEmpty()
Indicates whether or not this collection is currently empty.
|
java.util.Iterator<AlternateRetention> |
iterator()
Returns an iterator over the contents of this collection.
|
void |
remove(AlternateRetention altRetent)
Removes the
AlternateRetention instance from this collection. |
void |
remove(int index)
Removes the
AlternateRetention instance at the specified
1-based ordinal position. |
void |
remove(java.lang.String altRetentIdent)
Removes the identified
AlternateRetention instance from this collection. |
int |
size()
Returns the number of elements in this collection.
|
int add(AlternateRetention altRetent)
AlternateRetention
instance to the
end of this collection.
Persistence of changes to this collection will
not occur until the associated DispositionPhase.save
method or the associated DispositionSchedule.save
method is called.
altRetent
- the AlternateRetention
instance to add.
Cannot be null
.AlternateRetention
instance
within this collection.API_CANNOT_ADD_ALTRETENT_ALREADY_EXISTS
- if the specified AlternateRetention
instance
already exists in this collection.API_CANNOT_ADD_ALTRETENT_ALREADY_IN_USE
- if the specified AlternateRetention
instance
is already assigned to another phase.AlternateRetention get(int position)
AlternateRetention
instance at the
given 1-based ordinal position.position
- the 1-based ordinal position to retrieve from.AlternateRetention
instance.java.lang.IndexOutOfBoundsException
- if position is out-of-range.void remove(int index)
AlternateRetention
instance at the specified
1-based ordinal position.
The removed AlternateRetention
instance will be deleted from the repository
when either the associated DispositionPhase.save
method or the associated DispositionSchedule.save
method is called.
index
- the 1-based ordinal position to remove from.java.lang.IndexOutOfBoundsException
- if index is out-of-range.void remove(AlternateRetention altRetent)
AlternateRetention
instance from this collection.
The removed AlternateRetention
instance will be deleted from the repository
when either the associated DispositionPhase.save
method or the associated DispositionSchedule.save
method is called.
altRetent
- the AlternateRetention
instance to remove from
this collection. Cannot be null
.API_ALTRETENT_NOT_IN_COLLECTION
- if the specified AlternateRetention
instance
is not a member of this collection.void remove(java.lang.String altRetentIdent)
AlternateRetention
instance from this collection.
The removed AlternateRetention
instance will be deleted from the repository
when either the associated DispositionPhase.save
method or the associated DispositionSchedule.save
method is called.
altRetentIdent
- the String
alternate retention identifier.
Cannot be null
nor blank.API_ALTRETENT_NOT_IN_COLLECTION
- if the specified AlternateRetention
instance
is not a member of this collection.int size()
boolean isEmpty()
true
if the collection is empty;
false
otherwise.boolean contains(AlternateRetention altRetent)
AlternateRetention
instance is contained in this collection.altRetent
- the AlternateRetention
instance to test for containment.
Cannot be null
.true
if the specified altRetent is a member;
false
otherwise.java.util.Iterator<AlternateRetention> iterator()
iterator
in interface java.lang.Iterable<AlternateRetention>
Iterable.iterator()
© Copyright IBM Corp. 2010, 2013. All Rights Reserved.