VesselMasterPeriodDao (SIH-Adagio Core 3.3.1-rev-401 API)

All Known Implementing Classes:

VesselMasterPeriodDaoBase, VesselMasterPeriodDaoImpl
```
public interface VesselMasterPeriodDao
```
See Also:
VesselMasterPeriod

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`TRANSFORM_NONE` This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an `int` parameter called `transform`.

Method Summary

Methods
Modifier and Type	Method and Description
`Collection<VesselMasterPeriod>`	`create(Collection<VesselMasterPeriod> entities)` Creates a new instance of fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod and adds from the passed in `entities` collection
`VesselMasterPeriod`	`create(Date startDateTime, Date endDateTime, VesselMaster vesselMaster, Vessel vessel)` Creates a new `fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod` instance from all attributes and properties and adds it to the persistent store.
`VesselMasterPeriod`	`create(Date startDateTime, Vessel vessel, VesselMaster vesselMaster)` Creates a new `fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod` instance from only required properties (attributes and association ends) and adds it to the persistent store.
`Collection<?>`	`create(int transform, Collection<VesselMasterPeriod> entities)` Does the same thing as `create(fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod)` with an additional flag called `transform`.
`Object`	`create(int transform, Date startDateTime, Date endDateTime, VesselMaster vesselMaster, Vessel vessel)` Does the same thing as `create(java.util.Date,java.util.Date,fr.ifremer.adagio.core.dao.referential.vessel.VesselMaster,fr.ifremer.adagio.core.dao.referential.vessel.Vessel)` with an additional flag called `transform`.
`Object`	`create(int transform, Date startDateTime, Vessel vessel, VesselMaster vesselMaster)` Does the same thing as `create(java.util.Date,fr.ifremer.adagio.core.dao.referential.vessel.Vessel,fr.ifremer.adagio.core.dao.referential.vessel.VesselMaster)` with an additional flag called `transform`.
`Object`	`create(int transform, VesselMasterPeriod vesselMasterPeriod)` Does the same thing as `create(fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod)` with an additional flag called `transform`.
`VesselMasterPeriod`	`create(VesselMasterPeriod vesselMasterPeriod)` Creates an instance of fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod and adds it to the persistent store.
`VesselMasterPeriod`	`load(Date startDateTime, VesselMaster vesselMaster, Vessel vessel)` Loads an instance of fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod from the persistent store.
`Object`	`load(int transform, Date startDateTime, VesselMaster vesselMaster, Vessel vessel)` Does the same thing as `load(java.util.Date,fr.ifremer.adagio.core.dao.referential.vessel.VesselMaster,fr.ifremer.adagio.core.dao.referential.vessel.Vessel)` with an additional flag called `transform`.
`Collection<VesselMasterPeriod>`	`loadAll()` Loads all entities of type `VesselMasterPeriod`.
`Collection<?>`	`loadAll(int transform)` Does the same thing as `loadAll()` with an additional flag called `transform`.
`Collection<?>`	`loadAll(int pageNumber, int pageSize)` Does the same thing as `loadAll()` with an additional two arguments called `pageNumber` and `pageSize`.
`Collection<?>`	`loadAll(int transform, int pageNumber, int pageSize)` Does the same thing as `loadAll(int)` with an additional two arguments called `pageNumber` and `pageSize`.
`void`	`remove(Collection<VesselMasterPeriod> entities)` Removes all entities in the given `entities collection.`
`void`	`remove(Date startDateTime, VesselMaster vesselMaster, Vessel vessel)` Removes the instance of fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod having the given `identifiers` from the persistent store.
`void`	`remove(VesselMasterPeriod vesselMasterPeriod)` Removes the instance of fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod from the persistent store.
`PaginationResult`	`search(int transform, int pageNumber, int pageSize, Search search)` Does the same thing as {@link #search(int, fr.ifremer.adagio.core.dao.Search) but with an additional two flags called `pageNumber` and `pageSize`.
`PaginationResult`	`search(int pageNumber, int pageSize, Search search)` Does the same thing as {@link #search(fr.ifremer.adagio.core.dao.Search) but with an additional two flags called `pageNumber` and `pageSize`.
`Set<?>`	`search(int transform, Search search)` Does the same thing as `search(fr.ifremer.adagio.core.dao.Search)` but with an additional flag called `transform`.
`Set<VesselMasterPeriod>`	`search(Search search)` Performs a search using the parameters specified in the given `search` object.
`void`	`update(Collection<VesselMasterPeriod> entities)` Updates all instances in the `entities` collection in the persistent store.
`void`	`update(VesselMasterPeriod vesselMasterPeriod)` Updates the `vesselMasterPeriod` instance in the persistent store.

- Field Detail
  - TRANSFORM_NONE
```
static final int TRANSFORM_NONE
```
    This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.
    This specific flag denotes no transformation will occur.
    
    See Also:
    Constant Field Values
- Method Detail
  - load
```
VesselMasterPeriod load(Date startDateTime,
                      VesselMaster vesselMaster,
                      Vessel vessel)
```
    Loads an instance of fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod from the persistent store.
  - load
```
Object load(int transform,
          Date startDateTime,
          VesselMaster vesselMaster,
          Vessel vessel)
```
    Does the same thing as load(java.util.Date,fr.ifremer.adagio.core.dao.referential.vessel.VesselMaster,fr.ifremer.adagio.core.dao.referential.vessel.Vessel) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined in this class then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.
    
    Parameters:
    startDateTime - identifier of the entity to load
    vesselMaster - identifier of the entity to load
    vessel - identifier of the entity to load
    
    Returns:
    either the entity or the object transformed from the entity.
  - loadAll
```
Collection<VesselMasterPeriod> loadAll()
```
    Loads all entities of type VesselMasterPeriod.
    
    Returns:
    the loaded entities.
  - loadAll
```
Collection<?> loadAll(int transform)
```
    Does the same thing as loadAll() with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.
    
    Parameters:
    transform - the flag indicating what transformation to use.
    
    Returns:
    the loaded entities.
  - loadAll
```
Collection<?> loadAll(int pageNumber,
                    int pageSize)
```
    Does the same thing as loadAll() with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.
    
    Parameters:
    pageNumber - the page number to retrieve when paging results.
    pageSize - the size of the page to retrieve when paging results.
    
    Returns:
    the loaded entities.
  - loadAll
```
Collection<?> loadAll(int transform,
                    int pageNumber,
                    int pageSize)
```
    Does the same thing as loadAll(int) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.
    
    Parameters:
    transform - the flag indicating what transformation to use.
    pageNumber - the page number to retrieve when paging results.
    pageSize - the size of the page to retrieve when paging results.
    
    Returns:
    the loaded entities.
  - create
```
VesselMasterPeriod create(VesselMasterPeriod vesselMasterPeriod)
```
    Creates an instance of fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod and adds it to the persistent store.
  - create
```
Object create(int transform,
            VesselMasterPeriod vesselMasterPeriod)
```
    Does the same thing as create(fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.
  - create
```
Collection<VesselMasterPeriod> create(Collection<VesselMasterPeriod> entities)
```
    Creates a new instance of fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod and adds from the passed in entities collection
    
    Parameters:
    entities - the collection of fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod instances to create.
    
    Returns:
    the created instances.
  - create
```
Collection<?> create(int transform,
                   Collection<VesselMasterPeriod> entities)
```
    Does the same thing as create(fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.
  - create
```
VesselMasterPeriod create(Date startDateTime,
                        Date endDateTime,
                        VesselMaster vesselMaster,
                        Vessel vessel)
```
    Creates a new fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod instance from all attributes and properties and adds it to the persistent store.
  - create
```
Object create(int transform,
            Date startDateTime,
            Date endDateTime,
            VesselMaster vesselMaster,
            Vessel vessel)
```
    Does the same thing as create(java.util.Date,java.util.Date,fr.ifremer.adagio.core.dao.referential.vessel.VesselMaster,fr.ifremer.adagio.core.dao.referential.vessel.Vessel) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.
  - create
```
VesselMasterPeriod create(Date startDateTime,
                        Vessel vessel,
                        VesselMaster vesselMaster)
```
    Creates a new fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod instance from only required properties (attributes and association ends) and adds it to the persistent store.
  - create
```
Object create(int transform,
            Date startDateTime,
            Vessel vessel,
            VesselMaster vesselMaster)
```
    Does the same thing as create(java.util.Date,fr.ifremer.adagio.core.dao.referential.vessel.Vessel,fr.ifremer.adagio.core.dao.referential.vessel.VesselMaster) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOTWILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.
  - update
```
void update(VesselMasterPeriod vesselMasterPeriod)
```
    Updates the vesselMasterPeriod instance in the persistent store.
  - update
```
void update(Collection<VesselMasterPeriod> entities)
```
    Updates all instances in the entities collection in the persistent store.
  - remove
```
void remove(VesselMasterPeriod vesselMasterPeriod)
```
    Removes the instance of fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod from the persistent store.
  - remove
```
void remove(Date startDateTime,
          VesselMaster vesselMaster,
          Vessel vessel)
```
    Removes the instance of fr.ifremer.adagio.core.dao.referential.vessel.VesselMasterPeriod having the given identifiers from the persistent store.
  - remove
```
void remove(Collection<VesselMasterPeriod> entities)
```
    Removes all entities in the given entities collection.
  search PaginationResult search(int transform, int pageNumber, int pageSize, Search search) Does the same thing as {@link #search(int, fr.ifremer.adagio.core.dao.Search) but with an additional two flags called pageNumber and pageSize. These flags allow you to limit your data to a specified page number and size. Parameters: transform - the transformation flag. pageNumber - the page number in the data to retrieve pageSize - the size of the page to retrieve. search - the search object which provides the search parameters and pagination specification. Returns: any found results from the search wrapped in a PaginationResult instance. search PaginationResult search(int pageNumber, int pageSize, Search search) Does the same thing as {@link #search(fr.ifremer.adagio.core.dao.Search) but with an additional two flags called pageNumber and pageSize. These flags allow you to limit your data to a specified page number and size. Parameters: pageNumber - the page number in the data to retrieve pageSize - the size of the page to retrieve. search - the search object which provides the search parameters and pagination specification. Returns: any found results from the search wrapped in a PaginationResult instance. search Set<?> search(int transform, Search search) Does the same thing as search(fr.ifremer.adagio.core.dao.Search) but with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur. Parameters: transform - the transformation flag. search - the search object which provides the search parameters and pagination specification. Returns: any found results from the search. search Set<VesselMasterPeriod> search(Search search) Performs a search using the parameters specified in the given search object. Parameters: search - the search object which provides the search parameters and pagination specification. Returns: any found results from the search.

Interface VesselMasterPeriodDao

Field Summary

Method Summary

Field Detail

TRANSFORM_NONE

Method Detail

load

load

loadAll

loadAll

loadAll

loadAll

create

create

create

create

create

create

create

create

update

update

remove

remove

remove

search

search

search

search