Method Detail

• public EntityList addAllIfMissing(EntityList el)

  Adds each value in the passed list to this list if the value isn't already in it. Returns reference to this list.

• public EntityList addIfMissing(EntityValue value)

  Adds the value to this list if the value isn't already in it. Returns reference to this list.

• public EntityList cloneList()

• public EntityList filter(groovy.lang.Closure<java.lang.Boolean> closure, java.lang.Boolean include)

  Modify this EntityList so that it includes (or excludes) entity values where the closure evaluates to true. The closure is called with a single argument, the current EntityValue in the list, and should evaluate to a Boolean.

• public EntityList filterByAnd(java.util.Map<java.lang.String, java.lang.Object> fields)

  Modify this EntityList so that it contains only the values that match the values in the fields parameter.

  Returns:

  List of EntityValue objects that match the values in the fields parameter.

  Parameters:

  fields - The name/value pairs that must match for a value to be included in the output list.

• public EntityList filterByAnd(java.util.Map<java.lang.String, java.lang.Object> fields, java.lang.Boolean include)

• public EntityList filterByCondition(EntityCondition condition, java.lang.Boolean include)

  Modify this EntityList so that it includes (or excludes) values matching the condition.

  Returns:

  List with filtered values.

  Parameters:

  condition - EntityCondition to filter by.

  include - If true include matching values, if false exclude matching values. Defaults to true (include, ie only include values that do meet condition).

• public EntityList filterByDate(java.lang.String fromDateName, java.lang.String thruDateName, java.sql.Timestamp moment)

  Modify this EntityList so that it contains only the values that are active for the moment passed in. The results include values that match the fromDate, but exclude values that match the thruDate.

  Returns:

  A reference to this for convenience.

  Parameters:

  fromDateName - The name of the from/beginning date/time field. Defaults to "fromDate".

  thruDateName - The name of the thru/ending date/time field. Defaults to "thruDate".

  moment - The point in time to compare the values to; if null the current system date/time is used.

• public EntityList filterByDate(java.lang.String fromDateName, java.lang.String thruDateName, java.sql.Timestamp moment, boolean ignoreIfEmpty)

• public EntityList filterByLimit(java.lang.Integer offset, java.lang.Integer limit)

  Modify this EntityList to only contain up to limit values starting at the offset.

  Returns:

  List with filtered values.

  Parameters:

  offset - Starting index to include

  limit - Include only this many values

• public EntityList filterByLimit(java.lang.String inputFieldsMapName, boolean alwaysPaginate)

  For limit filter in a cached entity-find with search-form-inputs, done after the query

• public EntityValue find(groovy.lang.Closure<java.lang.Boolean> closure)

  Find the first value in this EntityList where the closure evaluates to true.

• public EntityList findAll(groovy.lang.Closure<java.lang.Boolean> closure)

  Different from filter* method semantics, does not modify this EntityList. Returns a new EntityList with just the values where the closure evaluates to true.

• public EntityValue getFirst()

  Get the first value in the list.

  Returns:

  EntityValue that is first in the list.

• public java.lang.Integer getLimit()

  The limit used to filter the list, if filterByLimit has been called.

• public java.util.List<java.util.Map<java.lang.String, java.lang.Object>> getMasterValueList(java.lang.String name)

• public java.lang.Integer getOffset()

  The offset used to filter the list, if filterByLimit has been called.

• public int getPageIndex()

  For use with filterByLimit when paginated. Equals offset (default 0) divided by page size.

• public int getPageSize()

  For use with filterByLimit when paginated. Equals limit (default 20; for use along with getPageIndex()).

• public java.util.List<java.util.Map<java.lang.String, java.lang.Object>> getPlainValueList(int dependentLevels)

  Get a list of Map (not EntityValue) objects. If dependentLevels is greater than zero includes nested dependents in the Map for each value.

• public int indexMatching(java.util.Map<java.lang.String, java.lang.Object> valueMap)

• public boolean isFromCache()

• @java.lang.Override public java.util.Iterator<EntityValue> iterator()

  Method to implement the Iterable interface to allow an EntityList to be used in a foreach loop.

  Returns:

  Iterator<EntityValue> to iterate over internal list.

• public void move(int fromIndex, int toIndex)

• public EntityList orderByFields(java.util.List<java.lang.String> fieldNames)

  Modify this EntityList so that is ordered by the field names passed in.

  Returns:

  List of EntityValue objects in the specified order.

  Parameters:

  fieldNames - The field names for the entity values to sort the list by. Optionally prefix each field name with a plus sign (+) for ascending or a minus sign (-) for descending. Defaults to ascending.

• public EntityList removeByAnd(java.util.Map<java.lang.String, java.lang.Object> fields)

• public void setFromCache()

• public int writeXmlText(java.io.Writer writer, java.lang.String prefix, int dependentLevels)

  Writes XML text with an attribute or CDATA element for each field of each record. If dependents is true also writes all dependent (descendant) records.

  Returns:

  The number of records written

  Parameters:

  writer - A Writer object to write to

  prefix - A prefix to put in front of the entity name in the tag name

  dependentLevels - Write dependent (descendant) records this many levels deep, zero for no dependents