net~ UserDatumAuxiliaryUrlHelperMixin

A mixin class that adds user datum auxiliary support to module:net~UrlHelper.

Methods

deleteUserDatumAuxiliaryUrl(type, nodeId, date, sourceId) → {string}

Generate a URL for deleting a DatumAuxiliaryType via a DELETE request.

The module:net~UserDatumAuxiliaryUrlHelperMixin#userDatumAuxiliaryIdUrl method is used to generate the URL.

Parameters:
NameTypeDescription
typemodule:domain~DatumAuxiliaryType

the datum auxiliary type

nodeIdnumber

the node ID

dateDate

a date

sourceIdstring

the source ID

Returns:

the URL

Type: 
string

listUserDatumAuxiliaryUrl(filter) → {string}

Generate a URL for viewing the configured user's metadata via a GET request.

Parameters:
NameTypeDescription
filtermodule:domain~DatumFilter

the search criteria

Returns:

the URL

Type: 
string

storeUserDatumAuxiliaryUrl(type, nodeId, date, sourceId) → {string}

Generate a URL for storing a DatumAuxiliaryType via a POST request.

The module:net~UserDatumAuxiliaryUrlHelperMixin#userDatumAuxiliaryIdUrl method is used to generate the URL.

Parameters:
NameTypeDescription
typemodule:domain~DatumAuxiliaryType

the datum auxiliary type

nodeIdnumber

the node ID

dateDate

a date

sourceIdstring

the source ID

Returns:

the URL

Type: 
string

userDatumAuxiliaryIdQueryUrl(type, nodeId, date, sourceId) → {string}

Generate a URL for accessing a specific DatumAuxiliaryType by its primary key, using query parameters for id components.

Parameters:
NameTypeDescription
typemodule:domain~DatumAuxiliaryType

the datum auxiliary type

nodeIdnumber

the node ID

dateDate

a date

sourceIdstring

the source ID

Returns:

the URL

Type: 
string

userDatumAuxiliaryIdUrl(type, nodeId, date, sourceId) → {string}

Generate a URL for accessing a specific DatumAuxiliaryType by its primary key.

If sourceId contains any / characters, then module:net~UserDatumAuxiliaryUrlHelperMixin#userDatumAuxiliaryIdQueryUrl will be invoked instead.

Parameters:
NameTypeDescription
typemodule:domain~DatumAuxiliaryType

the datum auxiliary type

nodeIdnumber

the node ID

dateDate

a date

sourceIdstring

the source ID

Returns:

the URL

Type: 
string

viewUserDatumAuxiliaryUrl(type, nodeId, date, sourceId) → {string}

Generate a URL for viewing a DatumAuxiliaryType via a GET request.

The module:net~UserDatumAuxiliaryUrlHelperMixin#userDatumAuxiliaryIdUrl method is used to generate the URL.

Parameters:
NameTypeDescription
typemodule:domain~DatumAuxiliaryType

the datum auxiliary type

nodeIdnumber

the node ID

dateDate

a date

sourceIdstring

the source ID

Returns:

the URL

Type: 
string