activity/streams/vocab/gen_property_subject_interf...

80 行
3.3 KiB
Go
Raw 通常表示 履歴

package vocab
import "net/url"
// On a Relationship object, the subject property identifies one of the connected
// individuals. For instance, for a Relationship object describing "John is
// related to Sally", subject would refer to John.
//
// Example 139 (https://www.w3.org/TR/activitystreams-vocabulary/#ex22a-jsonld):
// {
// "object": {
// "name": "John",
// "type": "Person"
// },
// "relationship": "http://purl.org/vocab/relationship/acquaintanceOf",
// "subject": {
// "name": "Sally",
// "type": "Person"
// },
// "summary": "Sally is an acquaintance of John's",
// "type": "Relationship"
// }
type SubjectPropertyInterface interface {
// Clear ensures no value of this property is set. Calling HasAny or any
// of the 'Is' methods afterwards will return false.
Clear()
// GetIRI returns the IRI of this property. When IsIRI returns false,
// GetIRI will return an arbitrary value.
GetIRI() *url.URL
// GetLink returns the value of this property. When IsLink returns false,
// GetLink will return an arbitrary value.
GetLink() LinkInterface
// GetObject returns the value of this property. When IsObject returns
// false, GetObject will return an arbitrary value.
GetObject() ObjectInterface
// HasAny returns true if any of the different values is set.
HasAny() bool
// IsIRI returns true if this property is an IRI. When true, use GetIRI
// and SetIRI to access and set this property
IsIRI() bool
// IsLink returns true if this property has a type of "Link". When true,
// use the GetLink and SetLink methods to access and set this property.
IsLink() bool
// IsObject returns true if this property has a type of "Object". When
// true, use the GetObject and SetObject methods to access and set
// this property.
IsObject() bool
// JSONLDContext returns the JSONLD URIs required in the context string
// for this property and the specific values that are set. The value
// in the map is the alias used to import the property's value or
// values.
JSONLDContext() map[string]string
// KindIndex computes an arbitrary value for indexing this kind of value.
// This is a leaky API detail only for folks looking to replace the
// go-fed implementation. Applications should not use this method.
KindIndex() int
// LessThan compares two instances of this property with an arbitrary but
// stable comparison. Applications should not use this because it is
// only meant to help alternative implementations to go-fed to be able
// to normalize nonfunctional properties.
LessThan(o SubjectPropertyInterface) bool
// Name returns the name of this property: "subject".
Name() string
// Serialize converts this into an interface representation suitable for
// marshalling into a text or binary format. Applications should not
// need this function as most typical use cases serialize types
// instead of individual properties. It is exposed for alternatives to
// go-fed implementations to use.
Serialize() (interface{}, error)
// SetIRI sets the value of this property. Calling IsIRI afterwards
// returns true.
SetIRI(v *url.URL)
// SetLink sets the value of this property. Calling IsLink afterwards
// returns true.
SetLink(v LinkInterface)
// SetObject sets the value of this property. Calling IsObject afterwards
// returns true.
SetObject(v ObjectInterface)
}