Difference between revisions of "Freeside:1.9:Documentation:Developer/FS/h cust svc"

From Freeside
Jump to: navigation, search
(import from POD)
 
(import from POD)
 
Line 7: Line 7:
  
 
==METHODS==
 
==METHODS==
 +
; date_deleted
 +
:Returns the date this service was deleted, if any.
 
; label END_TIMESTAMP [ START_TIMESTAMP ]
 
; label END_TIMESTAMP [ START_TIMESTAMP ]
:Returns a list consisting of: - The name of this historical service (from part_svc) - A meaningful identifier (username, domain, or mail alias) - The table name (i.e. svc_domain) for this historical service
+
:Returns a label for this historical service, if the service was created before END_TIMESTAMP and (optionally) not deleted before START_TIMESTAMP. Otherwise, returns an empty list.
 +
 
 +
:If a service is found, returns a list consisting of: - The name of this historical service (from part_svc) - A meaningful identifier (username, domain, or mail alias) - The table name (i.e. svc_domain) for this historical service
 
; h_svc_x END_TIMESTAMP [ START_TIMESTAMP ]
 
; h_svc_x END_TIMESTAMP [ START_TIMESTAMP ]
 
:Returns the FS::h_svc_XXX object for this service as of END_TIMESTAMP (i.e. an FS::h_svc_acct object or FS::h_svc_domain object, etc.) and (optionally) not cancelled before START_TIMESTAMP.
 
:Returns the FS::h_svc_XXX object for this service as of END_TIMESTAMP (i.e. an FS::h_svc_acct object or FS::h_svc_domain object, etc.) and (optionally) not cancelled before START_TIMESTAMP.

Latest revision as of 19:15, 18 February 2008

NAME

FS::h_cust_svc - Object method for h_cust_svc objects

SYNOPSIS

DESCRIPTION

An FS::h_cust_svc object represents a historical service. FS::h_cust_svc inherits from FS::h_Common and FS::cust_svc.

METHODS

date_deleted
Returns the date this service was deleted, if any.
label END_TIMESTAMP [ START_TIMESTAMP ]
Returns a label for this historical service, if the service was created before END_TIMESTAMP and (optionally) not deleted before START_TIMESTAMP. Otherwise, returns an empty list.
If a service is found, returns a list consisting of: - The name of this historical service (from part_svc) - A meaningful identifier (username, domain, or mail alias) - The table name (i.e. svc_domain) for this historical service
h_svc_x END_TIMESTAMP [ START_TIMESTAMP ]
Returns the FS::h_svc_XXX object for this service as of END_TIMESTAMP (i.e. an FS::h_svc_acct object or FS::h_svc_domain object, etc.) and (optionally) not cancelled before START_TIMESTAMP.

BUGS

SEE ALSO

FS::h_Common, FS::cust_svc, FS::Record, schema.html from the base documentation.