Package com.primavera.integration.client.bo.object

Class Location

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.Location
public class Location extends BusinessObject
The location is used to store address information including latitude and longitude. Locations can be assigned to resources, projects and/or activities.

See Also:   Quick reference of Location fields

  • Constructor Details

    • Location

      public Location(Session session)
      Class constructor specifying the Session. This constructor is most commonly used when create() is intended to be called on this object.
      Parameters:
      session - the Session

    • Location

      public Location(Session session, ObjectId objId) throws BusinessObjectException
      Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.
      Parameters:
      session - the Session
      objId - the ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • Location

      public Location(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
      Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.
      Parameters:
      session - the Session
      rowSet - the PrmRowSet retrieved from the server
      iIndex - the row index in the PrmRowSet associated with this business object
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

  • Method Details

    • loadProjects

      public BOIterator<Project> loadProjects(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated Project objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadActivities

      public BOIterator<Activity> loadActivities(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated Activity objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadResources

      public BOIterator<Resource> loadResources(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated Resource objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadBaselineProjects

      public BOIterator<BaselineProject> loadBaselineProjects(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated BaselineProject objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getObjectId

      public ObjectId getObjectId() throws BusinessObjectException
      Gets the unique ID of the location. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      getObjectId in class BusinessObject
      Returns:
      the value in the field ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setObjectId

      public void setObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the location. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      setObjectId in class BusinessObject
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getName

      public String getName() throws BusinessObjectException
      Gets the name of the location. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field Name
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setName

      public void setName(String s) throws BusinessObjectException
      Sets the name of the location. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAddressLine1

      public String getAddressLine1() throws BusinessObjectException
      Gets the first line of the address with street number and street name.
      Returns:
      the value in the field AddressLine1
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setAddressLine1

      public void setAddressLine1(String s) throws BusinessObjectException
      Sets the first line of the address with street number and street name.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAddressLine2

      public String getAddressLine2() throws BusinessObjectException
      Gets the second line of the address with street number and street name.
      Returns:
      the value in the field AddressLine2
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setAddressLine2

      public void setAddressLine2(String s) throws BusinessObjectException
      Sets the second line of the address with street number and street name.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCity

      public String getCity() throws BusinessObjectException
      Gets the city name of the address.
      Returns:
      the value in the field City
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCity

      public void setCity(String s) throws BusinessObjectException
      Sets the city name of the address.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getMunicipality

      public String getMunicipality() throws BusinessObjectException
      Gets the municipality name of the address.
      Returns:
      the value in the field Municipality
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setMunicipality

      public void setMunicipality(String s) throws BusinessObjectException
      Sets the municipality name of the address.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getState

      public String getState() throws BusinessObjectException
      Gets the state name of the address.
      Returns:
      the value in the field State
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setState

      public void setState(String s) throws BusinessObjectException
      Sets the state name of the address.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getStateCode

      public String getStateCode() throws BusinessObjectException
      Gets the state abbreviation of the address.
      Returns:
      the value in the field StateCode
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setStateCode

      public void setStateCode(String s) throws BusinessObjectException
      Sets the state abbreviation of the address.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCountry

      public String getCountry() throws BusinessObjectException
      Gets the country of the address. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field Country
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCountry

      public void setCountry(String s) throws BusinessObjectException
      Sets the country of the address. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCountryCode

      public String getCountryCode() throws BusinessObjectException
      Gets the country code of the address.
      Returns:
      the value in the field CountryCode
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCountryCode

      public void setCountryCode(String s) throws BusinessObjectException
      Sets the country code of the address.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPostalCode

      public String getPostalCode() throws BusinessObjectException
      Gets the postal code of the address.
      Returns:
      the value in the field PostalCode
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPostalCode

      public void setPostalCode(String s) throws BusinessObjectException
      Sets the postal code of the address.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLongitude

      public double getLongitude() throws BusinessObjectException
      Gets the longitude of the location. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field Longitude
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setLongitude

      public void setLongitude(double d) throws BusinessObjectException
      Sets the longitude of the location. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLatitude

      public double getLatitude() throws BusinessObjectException
      Gets the latitude of the location. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field Latitude
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setLatitude

      public void setLatitude(double d) throws BusinessObjectException
      Sets the latitude of the location. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this location was created.
      Returns:
      the value in the field CreateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateDate

      public Date getLastUpdateDate() throws BusinessObjectException
      Gets the date this location was last updated.
      Returns:
      the value in the field LastUpdateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateUser

      public String getCreateUser() throws BusinessObjectException
      Gets the name of the user that created this location.
      Returns:
      the value in the field CreateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateUser

      public String getLastUpdateUser() throws BusinessObjectException
      Gets the name of the user that last updated this location.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRequiredCreateFields

      public static String[] getRequiredCreateFields()
      Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.
      Returns:
      String[] an array of required create fields

    • getFilterableFields

      public static String[] getFilterableFields()
      Gets all fields that can be filtered.
      Returns:
      String[] an array of filterable fields

    • getInternalDefaultLoadFields

      public static String[] getInternalDefaultLoadFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getAllFields

      public static String[] getAllFields()
      Gets all fields for this business object.
      Returns:
      String[] an array of all fields

    • getInternalAllFields

      public static String[] getInternalAllFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getInternalAllFieldsSet

      public static Set<String> getInternalAllFieldsSet()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getWritableFields

      public static String[] getWritableFields()
      Gets all writable fields for this business object.
      Returns:
      String[] an array of writable fields

    • getDefaultXMLExportFields

      @Deprecated public static String[] getDefaultXMLExportFields()
      Deprecated.
      Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.
      Returns:
      String[] an array of field names

    • getMinimumXMLExportFields

      public static String[] getMinimumXMLExportFields()
      Gets all fields that are always exported at a minimum by the new flat XML exporter
      Returns:
      String[] an array of exported fields

    • toString

      public String toString()
      Returns a string representation of the object. The output is in XML.
      Overrides:
      toString in class Object
      Returns:
      String a string representation of the object.

    • create

      public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
      Creates this Location object in the database.
      Returns:
      ObjectId the unique ID of the newly created Location object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • create

      public static ObjectId[] create(Session session, Location[] locations) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple Location objects in the database.
      Parameters:
      session - the Session object
      locations - array of Location objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created Location objects
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • load

      public static Location load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single Location object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the Location object
      Returns:
      Location the Location object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • load

      public static BOIterator<Location> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple Location objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the Location objects
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • update

      public void update() throws ServerException, NetworkException, BusinessObjectException
      Updates this Location object in the database.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • update

      public static void update(Session session, Location[] locations) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple Location objects in the database.
      Parameters:
      session - the Session object
      locations - array of Location objects to update
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • delete

      public void delete() throws ServerException, NetworkException, BusinessObjectException
      Deletes this Location object from the database.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • delete

      public static void delete(Session session, Location[] locations) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple Location objects from the database.
      Parameters:
      session - the Session object
      locations - array of Location objects to delete
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects