[Location] can retrieve contextual location

Clarify naming of method for retrieving contextual location of a domain
object.

Default behavior for objects that do not have a context is to return
undefined.  Note that default behavior is not specified and could change
if needed.
This commit is contained in:
Pete Richards 2015-08-19 11:28:58 -07:00
parent 9cf30f4213
commit 94854e5965
3 changed files with 13 additions and 11 deletions

View File

@ -40,16 +40,17 @@ define(
};
/**
* Return the current location of the current domain object. Only
* Returns the contextual location of the current domain object. Only
* valid for domain objects that have a context capability.
*
* @returns {String} the contextual location of the object; the id of
* its parent.
*/
LocationCapability.prototype.getLocation = function () {
var context = this.domainObject.getCapability("context"),
pathObjects,
pathIds;
LocationCapability.prototype.getContextualLocation = function () {
var context = this.domainObject.getCapability("context");
if (!context) {
return '';
return;
}
return context.getParent().getId();
@ -65,7 +66,7 @@ define(
}
var model = this.domainObject.getModel();
return model.location !== this.getLocation();
return model.location !== this.getContextualLocation();
};
/**
@ -78,7 +79,7 @@ define(
}
var model = this.domainObject.getModel();
return model.location === this.getLocation();
return model.location === this.getContextualLocation();
};
function createLocationCapability(domainObject) {

View File

@ -83,7 +83,8 @@ define(
if (oldLocationCapability.isOriginal()) {
return newLocationCapability.setPrimaryLocation(
newLocationCapability.getLocation()
newLocationCapability
.getContextualLocation()
);
}
})

View File

@ -52,8 +52,8 @@ define(
locationCapability = new LocationCapability(domainObject);
});
it("returns location", function () {
expect(locationCapability.getLocation())
it("returns contextual location", function () {
expect(locationCapability.getContextualLocation())
.toBe('root');
});