activity/streams/vocab/gen_property_partOf_interfa...

81 行
3.3 KiB
Go

package vocab
import "net/url"
// Identifies the Collection to which a CollectionPage objects items belong.
//
// Example 123 (https://www.w3.org/TR/activitystreams-vocabulary/#ex139-jsonld):
// {
// "id": "http://example.org/collection?page=1",
// "items": [
// {
// "name": "Pizza Toppings to Try",
// "type": "Note"
// },
// {
// "name": "Thought about California",
// "type": "Note"
// }
// ],
// "partOf": "http://example.org/collection",
// "summary": "Page 1 of Sally's notes",
// "type": "CollectionPage"
// }
type PartOfPropertyInterface interface {
// Clear ensures no value of this property is set. Calling HasAny or any
// of the 'Is' methods afterwards will return false.
Clear()
// GetCollection returns the value of this property. When IsCollection
// returns false, GetCollection will return an arbitrary value.
GetCollection() CollectionInterface
// 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
// HasAny returns true if any of the different values is set.
HasAny() bool
// IsCollection returns true if this property has a type of "Collection".
// When true, use the GetCollection and SetCollection methods to
// access and set this property.
IsCollection() 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
// 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 PartOfPropertyInterface) bool
// Name returns the name of this property: "partOf".
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)
// SetCollection sets the value of this property. Calling IsCollection
// afterwards returns true.
SetCollection(v CollectionInterface)
// 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)
}